GemFire 6.6.1

com.gemstone.gemfire.admin
Interface ConfigurationParameter


public interface ConfigurationParameter

A single configuration parameter of a SystemMember.

Since:
3.5

Method Summary
 String getDescription()
          Gets the full description of this configuration parameter
 String getName()
          Gets the identifying name of this configuration parameter.
 Object getValue()
          Gets the current value
 String getValueAsString()
          Gets the current value as a string
 Class getValueType()
          Gets the class type of the value
 boolean isArray()
          Returns true if this config parameter uses a string array for value.
 boolean isFile()
          Returns true if this config parameter represents a File value.
 boolean isInetAddress()
          Returns true if this config parameter represents an InetAddress value.
 boolean isModifiable()
          True if this is modifiable; false if read-only
 boolean isOctal()
          Returns true if this config parameter represents an octal value.
 boolean isString()
          Returns true if this config parameter represents a string value.
 void setValue(Object value)
          Sets a new value for this configuration parameter.
 

Method Detail

getName

String getName()
Gets the identifying name of this configuration parameter.


getDescription

String getDescription()
Gets the full description of this configuration parameter


getValue

Object getValue()
Gets the current value


getValueAsString

String getValueAsString()
Gets the current value as a string


getValueType

Class getValueType()
Gets the class type of the value


isModifiable

boolean isModifiable()
True if this is modifiable; false if read-only


isArray

boolean isArray()
Returns true if this config parameter uses a string array for value.


isInetAddress

boolean isInetAddress()
Returns true if this config parameter represents an InetAddress value.


isFile

boolean isFile()
Returns true if this config parameter represents a File value.


isOctal

boolean isOctal()
Returns true if this config parameter represents an octal value.


isString

boolean isString()
Returns true if this config parameter represents a string value.


setValue

void setValue(Object value)
              throws UnmodifiableConfigurationException
Sets a new value for this configuration parameter.

Parameters:
value - the new value which must be of type getValueType()
Throws:
IllegalArgumentException - if value type does not match getValueType()
UnmodifiableConfigurationException - if attempting to set value when isModifiable is false

GemFire 6.6.1

Copyright © 1997-2011 VMware, Inc. All rights reserved.