public class MbConfigObject
extends java.lang.Object
getConfigObject()
method of MbNode.Constructor and Description |
---|
MbConfigObject(long handle_)
The only constructor for a config object accepts the native handle
to the C++ config object
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
asString()
Returns a string representation of the config object
|
MbConfigObject |
findPolicy(java.lang.String policyType,
java.lang.String policyName)
Retrieves the closest relevant policy to this object.
|
boolean |
getBooleanPropertyValue(java.lang.String propertyName)
Retrieves the boolean value for the named property.
|
MbConfigObject |
getChildByIdentifier(java.lang.String id)
Returns the child object for the matching internal identifier
|
java.util.Collection<MbProperty> |
getDescriptiveProperties()
Return a collection containing the descriptive properties
|
MbProperty |
getDescriptiveProperty(java.lang.String name)
Returns the named descriptive property from the config object
|
java.lang.Object |
getDescriptivePropertyValue(java.lang.String name)
Returns the value of the named descriptive property from the config object
|
java.lang.String |
getDescriptiveStringPropertyValue(java.lang.String propertyName)
Retrieves the character value for the named descriptive property.
|
MbConfigObject |
getFirstChild(java.lang.String name)
Returns the child object matching the provided name
|
int |
getIntegerPropertyValue(java.lang.String propertyName)
Retrieves the int value for the named property.
|
long |
getLongPropertyValue(java.lang.String propertyName)
Retrieves the long value for the named property.
|
java.util.Collection<MbProperty> |
getProperties()
Return a collection containing the properties
|
MbProperty |
getProperty(java.lang.String name)
Returns the named property from the config object
|
java.lang.Object |
getPropertyValue(java.lang.String name)
Returns the value of the named property from the config object
|
java.lang.String |
getStringPropertyValue(java.lang.String propertyName)
Retrieves the character value for the named property.
|
java.lang.String |
getStringPropertyValue(java.lang.String propertyName,
java.lang.String defaultValue)
Retrieves the string value for the named property.
|
boolean |
hasProperty(java.lang.String name)
Returns the value of the named property from the config object
|
java.lang.String |
internalIdentifier()
Returns the internalIdentifier of the config object as a string
|
boolean |
isPropertyValueValid(java.lang.String name)
Returns whether the value of the named property from the config
object has a valid value
|
java.lang.String |
longDescription()
Returns the longDescription property of the config object as a string
|
java.lang.String |
name()
Returns the name of the config object as a string
|
int |
numberOfChildren()
Returns the number of children config objects
|
int |
numberOfChildren(java.lang.String name)
Returns the number of children config objects matching the supplied name
|
int |
numberOfDescriptiveProperties()
Returns the number of descriptive properties in the config object
|
int |
numberOfProperties()
Returns the number of properties in the config object
|
MbConfigObject |
owner()
Returns the parent config object
|
java.lang.String |
shortDescription()
Returns the shortDescription property of the config object as a string
|
java.lang.String |
type()
Returns the type property of the config object as a string
|
java.lang.String |
version()
Returns the version property of the config object as a string
|
public MbConfigObject(long handle_)
public java.lang.String name() throws MbException
MbException
public java.lang.String type() throws MbException
MbException
public java.lang.String internalIdentifier() throws MbException
MbException
public java.lang.String version() throws MbException
MbException
public java.lang.String shortDescription() throws MbException
MbException
public java.lang.String longDescription() throws MbException
MbException
public java.lang.String asString() throws MbException
MbException
public int numberOfProperties() throws MbException
MbException
public int numberOfDescriptiveProperties() throws MbException
MbException
public java.lang.Object getPropertyValue(java.lang.String name) throws MbException
name
- The property to be returnedMbException
public boolean hasProperty(java.lang.String name) throws MbException
name
- The property to be returnedMbException
public boolean isPropertyValueValid(java.lang.String name) throws MbException
name
- The property to be returnedMbException
public java.lang.Object getDescriptivePropertyValue(java.lang.String name) throws MbException
name
- The property to be returnedMbException
public java.lang.String getDescriptiveStringPropertyValue(java.lang.String propertyName) throws MbException
MbException
public MbProperty getProperty(java.lang.String name) throws MbException
name
- The property to be returnedMbException
public MbProperty getDescriptiveProperty(java.lang.String name) throws MbException
name
- The property to be returnedMbException
public MbConfigObject owner() throws MbException
MbException
public int numberOfChildren() throws MbException
MbException
public int numberOfChildren(java.lang.String name) throws MbException
MbException
public MbConfigObject getFirstChild(java.lang.String name) throws MbException
name
- The name of the child to be returnedMbException
public MbConfigObject getChildByIdentifier(java.lang.String id) throws MbException
id
- The internal identifier of the child to be returnedMbException
public java.util.Collection<MbProperty> getProperties() throws MbException
MbException
public java.util.Collection<MbProperty> getDescriptiveProperties() throws MbException
MbException
public boolean getBooleanPropertyValue(java.lang.String propertyName) throws MbException
MbException
public java.lang.String getStringPropertyValue(java.lang.String propertyName) throws MbException
MbException
public java.lang.String getStringPropertyValue(java.lang.String propertyName, java.lang.String defaultValue)
public long getLongPropertyValue(java.lang.String propertyName) throws MbException
MbException
public int getIntegerPropertyValue(java.lang.String propertyName) throws MbException
MbException
public MbConfigObject findPolicy(java.lang.String policyType, java.lang.String policyName) throws MbException
MbException