Hyperic HQ Plugin API v. 4.4.0.2

org.hyperic.util.config
Class EnumerationConfigOption

java.lang.Object
  extended by org.hyperic.util.config.ConfigOption
      extended by org.hyperic.util.config.EnumerationConfigOption
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
BooleanConfigOption, YesNoConfigOption

public class EnumerationConfigOption
extends ConfigOption
implements java.io.Serializable

See Also:
Serialized Form

Constructor Summary
EnumerationConfigOption(java.lang.String optName, java.lang.String optDesc, java.lang.String defValue, java.lang.String[] enumValues)
          This constructor allows you to create an EnumConfigOption and supply the valid enum values at construction time.
EnumerationConfigOption(java.lang.String optName, java.lang.String optDesc, java.lang.String defValue, java.lang.String[] enumValues, java.lang.String confirm)
           
 
Method Summary
 void addValue(java.lang.String option)
          Option properties
 void checkOptionIsValid(java.lang.String value)
           
 java.lang.String getDefault()
           
 java.util.List getValues()
           
 
Methods inherited from class org.hyperic.util.config.ConfigOption
copy, equals, getCategory, getConfirm, getDescription, getName, hashCode, invalidOption, isOptional, setCategory, setConfirm, setDefault, setDescription, setName, setOptional, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EnumerationConfigOption

public EnumerationConfigOption(java.lang.String optName,
                               java.lang.String optDesc,
                               java.lang.String defValue,
                               java.lang.String[] enumValues)
This constructor allows you to create an EnumConfigOption and supply the valid enum values at construction time.


EnumerationConfigOption

public EnumerationConfigOption(java.lang.String optName,
                               java.lang.String optDesc,
                               java.lang.String defValue,
                               java.lang.String[] enumValues,
                               java.lang.String confirm)
Method Detail

checkOptionIsValid

public void checkOptionIsValid(java.lang.String value)
                        throws InvalidOptionValueException
Specified by:
checkOptionIsValid in class ConfigOption
Throws:
InvalidOptionValueException

getDefault

public java.lang.String getDefault()
Overrides:
getDefault in class ConfigOption

addValue

public void addValue(java.lang.String option)
Option properties


getValues

public java.util.List getValues()

Hyperic HQ Plugin API v. 4.4.0.2

Copyright © 2004-2006 Hyperic, Inc. support@hyperic.net, All Rights Reserved.