org.openanzo.util.properties
Class PropertiesDefinitionParser.Property

java.lang.Object
  org.openanzo.util.properties.PropertiesDefinitionParser.Property

Enclosing class:

PropertiesDefinitionParser

public class PropertiesDefinitionParser.Property
extends java.lang.Object

Class representing a Property

Constructor Summary

PropertiesDefinitionParser.Property()

Method Summary

PropertiesDefinitionParser.Description	getClientDescription() Return special description information when this property is being used in client mode
PropertiesDefinitionParser.Example	getClientExample() Return special example information when this property is being used in client mode
java.lang.String	getDefaultValue() Get the default value for this property
PropertiesDefinitionParser.Description	getEmbeddedDescription() Return special description information when this property is being used in embedded mode
PropertiesDefinitionParser.Example	getEmbeddedExample() Return special example information when this property is being used in embedded mode
java.util.ArrayList<PropertiesDefinitionParser.Description>	getGeneralDescription() Get the general description for this property
java.util.ArrayList<PropertiesDefinitionParser.Example>	getGeneralExample() Return example information for this property
java.lang.String	getKey() Get the key string for this property
java.lang.String	getMaxValue() Return the maximum value constraint on this property
java.lang.String	getMinValue() Return the minimum value constraint on this property
java.lang.String	getName() Get the name of this property
boolean	getPassDefault() Should get method take a default value as a parameter
boolean	getQuoteDefault() Return if quote characters should be placed around the default value string
PropertiesDefinitionParser.Description	getServerDescription() Return special description information when this property is being used in server mode
PropertiesDefinitionParser.Example	getServerExample() Return special example information when this property is being used in server mode
java.util.ArrayList<PropertiesDefinitionParser.Tag>	getTags() Return any special tags for this property like @see
PropertiesDefinitionParser.PropType	getType() Get the property value type
boolean	hasDescription() Determine if this property has a description
boolean	hasExample() Determine if this property has an example

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertiesDefinitionParser.Property

public PropertiesDefinitionParser.Property()

Method Detail

hasDescription

public boolean hasDescription()

Determine if this property has a description

Returns:

true if this property has a description

hasExample

public boolean hasExample()

Determine if this property has an example

Returns:

true if this property has an example

getName

public java.lang.String getName()

Get the name of this property

Returns:

the name of this property

getKey

public java.lang.String getKey()

Get the key string for this property

Returns:

the key string for this property

getType

public PropertiesDefinitionParser.PropType getType()

Get the property value type

Returns:

the property value type

getDefaultValue

public java.lang.String getDefaultValue()

Get the default value for this property

Returns:

the default value for this property

getPassDefault

public boolean getPassDefault()

Should get method take a default value as a parameter

Returns:

if method should take a default value as a parameter

getGeneralDescription

public java.util.ArrayList<PropertiesDefinitionParser.Description> getGeneralDescription()

Get the general description for this property

Returns:

the general description for this property

getClientDescription

public PropertiesDefinitionParser.Description getClientDescription()

Return special description information when this property is being used in client mode

Returns:

special description information when this property is being used in client mode

getServerDescription

public PropertiesDefinitionParser.Description getServerDescription()

Return special description information when this property is being used in server mode

Returns:

special description information when this property is being used in server mode

getEmbeddedDescription

public PropertiesDefinitionParser.Description getEmbeddedDescription()

Return special description information when this property is being used in embedded mode

Returns:

special description information when this property is being used in embedded mode

getGeneralExample

public java.util.ArrayList<PropertiesDefinitionParser.Example> getGeneralExample()

Return example information for this property

Returns:

example information for this property

getClientExample

public PropertiesDefinitionParser.Example getClientExample()

Return special example information when this property is being used in client mode

Returns:

special example information when this property is being used in client mode

getServerExample

public PropertiesDefinitionParser.Example getServerExample()

Return special example information when this property is being used in server mode

Returns:

special example information when this property is being used in server mode

getEmbeddedExample

public PropertiesDefinitionParser.Example getEmbeddedExample()

Return special example information when this property is being used in embedded mode

Returns:

special example information when this property is being used in embedded mode

getQuoteDefault

public boolean getQuoteDefault()

Return if quote characters should be placed around the default value string

Returns:

true if quote characters should be placed around the default value string

getTags

public java.util.ArrayList<PropertiesDefinitionParser.Tag> getTags()

Return any special tags for this property like @see

Returns:

any special tags for this property like @see

getMinValue

public java.lang.String getMinValue()

Return the minimum value constraint on this property

Returns:

the minimum value constraint on this property

getMaxValue

public java.lang.String getMaxValue()

Return the maximum value constraint on this property

Returns:

the maximum value constraint on this property