Package org.teiid.adminapi.impl
Class PropertyDefinitionMetadata
- java.lang.Object
-
- org.teiid.adminapi.impl.AdminObjectImpl
-
- org.teiid.adminapi.impl.PropertyDefinitionMetadata
-
- All Implemented Interfaces:
Serializable
,AdminObject
,PropertyDefinition
public class PropertyDefinitionMetadata extends AdminObjectImpl implements PropertyDefinition
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.teiid.adminapi.PropertyDefinition
PropertyDefinition.RestartType
-
-
Field Summary
-
Fields inherited from class org.teiid.adminapi.impl.AdminObjectImpl
attachments
-
Fields inherited from interface org.teiid.adminapi.AdminObject
DELIMITER, DELIMITER_CHAR, ESCAPED_DELIMITER, ESCAPED_WILDCARD, WILDCARD
-
Fields inherited from interface org.teiid.adminapi.PropertyDefinition
UNBOUNDED_VALUE
-
-
Constructor Summary
Constructors Constructor Description PropertyDefinitionMetadata()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Collection
getAllowedValues()
Get the allowed values for this property.String
getCategory()
Get the category of the propertyObject
getDefaultValue()
Get the default value for values of this property, or an empty String if there is no default value.String
getDescription()
Get the description of this property.String
getDisplayName()
Get the localized display name of this property.String
getPropertyTypeClassName()
Get the name of the java class that best represents the property type.PropertyDefinition.RestartType
getRequiresRestart()
Get whether this property requires the system to be restarted before it takes effect.boolean
isAdvanced()
The "expert" flag is used to distinguish between features that are intended for expert users from those that are intended for normal users.boolean
isConstrainedToAllowedValues()
Return whether the value or values for this property are constrained to be only those in the AllowedValues list.boolean
isMasked()
The "masked" flag is used to tell whether the value should be masked when displayed to users.boolean
isModifiable()
The modifiable flag is used to identify features that may not be changed once they are set.boolean
isRequired()
The "required" flag is used to identify features that require at least one value (possibly a default value) by the consumer of the property.void
setAdvanced(boolean expert)
void
setAllowedValues(Collection allowedValues)
void
setCategory(String category)
void
setDefaultValue(Serializable defaultValue)
void
setDescription(String description)
void
setDisplayName(String displayName)
void
setMasked(boolean masked)
void
setModifiable(boolean modifiable)
void
setPropertyTypeClassName(String propertyTypeClassName)
void
setRequired(boolean required)
void
setRequiresRestart(PropertyDefinition.RestartType requiresRestart)
String
toString()
-
Methods inherited from class org.teiid.adminapi.impl.AdminObjectImpl
addAttachment, addAttchment, addProperty, getAttachment, getHostName, getName, getProperties, getPropertiesMap, getPropertyValue, getServerGroup, getServerName, removeAttachment, removeProperty, setHostName, setName, setProperties, setServerGroup, setServerName
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.teiid.adminapi.AdminObject
getName, getProperties, getPropertyValue
-
-
-
-
Method Detail
-
toString
public String toString()
- Overrides:
toString
in classObject
- See Also:
Object.toString()
-
getAllowedValues
public Collection getAllowedValues()
Description copied from interface:PropertyDefinition
Get the allowed values for this property.- Specified by:
getAllowedValues
in interfacePropertyDefinition
- Returns:
- the list of allowed values for this property, or an empty set if the values do not have to conform to a fixed set.
- See Also:
PropertyDefinition.getAllowedValues()
-
getDefaultValue
public Object getDefaultValue()
Description copied from interface:PropertyDefinition
Get the default value for values of this property, or an empty String if there is no default value.- Specified by:
getDefaultValue
in interfacePropertyDefinition
- Returns:
- the default value for this property, or an empty String if there is no default value.
- See Also:
PropertyDefinition.getDefaultValue()
-
getDescription
public String getDescription()
Description copied from interface:PropertyDefinition
Get the description of this property.- Specified by:
getDescription
in interfacePropertyDefinition
- Returns:
- the description for this property
- See Also:
PropertyDefinition.getDescription()
-
getDisplayName
public String getDisplayName()
Description copied from interface:PropertyDefinition
Get the localized display name of this property.- Specified by:
getDisplayName
in interfacePropertyDefinition
- Returns:
- the displayable name for this property
- See Also:
PropertyDefinition.getDisplayName()
-
getPropertyTypeClassName
public String getPropertyTypeClassName()
Description copied from interface:PropertyDefinition
Get the name of the java class that best represents the property type.- Specified by:
getPropertyTypeClassName
in interfacePropertyDefinition
- Returns:
- the name of the java class that best represents the property type.
- See Also:
PropertyDefinition.getPropertyTypeClassName()
-
getRequiresRestart
public PropertyDefinition.RestartType getRequiresRestart()
Description copied from interface:PropertyDefinition
Get whether this property requires the system to be restarted before it takes effect.- Specified by:
getRequiresRestart
in interfacePropertyDefinition
- Returns:
- true if this property requires the system to be restarted before it takes effect.
- See Also:
PropertyDefinition.getRequiresRestart()
-
isAdvanced
public boolean isAdvanced()
Description copied from interface:PropertyDefinition
The "expert" flag is used to distinguish between features that are intended for expert users from those that are intended for normal users.- Specified by:
isAdvanced
in interfacePropertyDefinition
- Returns:
- true if this property is to be marked with the expert flag, or false otherwise.
- Since:
- 4.3
- See Also:
PropertyDefinition.isAdvanced()
-
isMasked
public boolean isMasked()
Description copied from interface:PropertyDefinition
The "masked" flag is used to tell whether the value should be masked when displayed to users.- Specified by:
isMasked
in interfacePropertyDefinition
- Returns:
- true if this property value is to be masked, or false otherwise.
- See Also:
PropertyDefinition.isMasked()
-
isModifiable
public boolean isModifiable()
Description copied from interface:PropertyDefinition
The modifiable flag is used to identify features that may not be changed once they are set.- Specified by:
isModifiable
in interfacePropertyDefinition
- Returns:
- true if this property is marked with the modifyable flag, or false otherwise.
- See Also:
PropertyDefinition.isModifiable()
-
isRequired
public boolean isRequired()
Description copied from interface:PropertyDefinition
The "required" flag is used to identify features that require at least one value (possibly a default value) by the consumer of the property. Whether a property definition is required or not can be determined entirely from the multiplicity: if the multiplicity includes '0', then the property is not required.Whether a property is required by the consumer is unrelated to whether there is a default value, which only simplifies the task of the property provider. A property may be required, meaning it must have at least one value, but that same property definition may or may not have a default. The combination of required and whether it has a default will determine whether the user must supply a value.
- Specified by:
isRequired
in interfacePropertyDefinition
- Returns:
- true if this property requires at least one value.
- See Also:
PropertyDefinition.isRequired()
-
setAllowedValues
public void setAllowedValues(Collection allowedValues)
- Parameters:
allowedValues
- The allowedValues to set.
-
setDefaultValue
public void setDefaultValue(Serializable defaultValue)
- Parameters:
defaultValue
- The defaultValue to set.
-
setDescription
public void setDescription(String description)
- Parameters:
description
- The description to set.
-
setDisplayName
public void setDisplayName(String displayName)
- Parameters:
displayName
- The displayName to set.
-
setAdvanced
public void setAdvanced(boolean expert)
- Parameters:
expert
- The value of expert to set.
-
setMasked
public void setMasked(boolean masked)
- Parameters:
masked
- The value of masked to set.
-
setModifiable
public void setModifiable(boolean modifiable)
- Parameters:
modifiable
- The value of modifiable to set.
-
setPropertyTypeClassName
public void setPropertyTypeClassName(String propertyTypeClassName)
- Parameters:
propertyTypeClassName
- The propertyTypeName to set.
-
setRequired
public void setRequired(boolean required)
- Parameters:
required
- The value of required to set.
-
setRequiresRestart
public void setRequiresRestart(PropertyDefinition.RestartType requiresRestart)
- Parameters:
requiresRestart
- The value of requiresRestart to set.
-
isConstrainedToAllowedValues
public boolean isConstrainedToAllowedValues()
Description copied from interface:PropertyDefinition
Return whether the value or values for this property are constrained to be only those in the AllowedValues list.- Specified by:
isConstrainedToAllowedValues
in interfacePropertyDefinition
- Returns:
- true if this property's value must be with the list of AllowedValues.
- See Also:
PropertyDefinition.getAllowedValues()
-
getCategory
public String getCategory()
Description copied from interface:PropertyDefinition
Get the category of the property- Specified by:
getCategory
in interfacePropertyDefinition
- Returns:
- if null, no category exists
-
setCategory
public void setCategory(String category)
-
-