|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.metamatrix.common.config.api.ComponentTypePropDefn
public class ComponentTypePropDefn
ComponentTypePropDefn is an unmodifiable wrapper for the PropertyDefinition. Notice that this contains an origPropertyDefinition from which it returns values. This is done so that an instance of this class can be instantiated and passed a PropertyDefinition.
Constructor Summary | |
---|---|
ComponentTypePropDefn()
|
|
ComponentTypePropDefn(PropertyDefinition definition)
|
|
ComponentTypePropDefn(java.lang.String name,
java.lang.String displayName,
PropertyType type,
boolean required)
|
|
ComponentTypePropDefn(java.lang.String name,
java.lang.String displayName,
PropertyType type,
boolean required,
java.lang.String shortDescription,
java.lang.String defaultValue,
java.util.List allowedValues,
java.lang.String valueDelimiter,
boolean isHidden,
boolean isPreferred,
boolean isExpert,
boolean isModifiable)
|
Method Summary | |
---|---|
int |
compareTo(java.lang.Object obj)
Compares this object to another. |
boolean |
equals(java.lang.Object obj)
Returns true if the specified object is semantically equal to this instance. |
java.util.List |
getAllowedValues()
Get the allowed values for this property. |
java.lang.Object |
getDefaultValue()
Get the default value for values of this property, or an empty String if there is no default value. |
java.lang.String |
getDisplayName()
Get the localized display name of this property. |
java.lang.String |
getName()
Get the actual or programmatic name of this property. |
java.lang.String |
getPluralDisplayName()
Get the localized display name of this property. |
PropertyType |
getPropertyType()
Get the type for values of this property. |
PropertyDefinition.RestartType |
getRequiresRestart()
Get whether this property requires the system to be restarted before it takes effect. |
java.lang.String |
getShortDescription()
Get the short description of this property. |
java.lang.String |
getShortDisplayName()
Get the localized display name of this property. |
boolean |
hasDefaultValue()
Return whether there is a default value for this property. |
int |
hashCode()
Returns the hash code value for this object. |
boolean |
isConstrainedToAllowedValues()
Return whether the value or values for this property are constrained to be only those in the AllowedValues list. |
boolean |
isExpert()
The "expert" flag is used to distinguish between features that are intended for expert users from those that are intended for normal users. |
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. |
java.lang.String |
toString()
Returns a string representing the current state of the object. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ComponentTypePropDefn()
public ComponentTypePropDefn(PropertyDefinition definition)
public ComponentTypePropDefn(java.lang.String name, java.lang.String displayName, PropertyType type, boolean required, java.lang.String shortDescription, java.lang.String defaultValue, java.util.List allowedValues, java.lang.String valueDelimiter, boolean isHidden, boolean isPreferred, boolean isExpert, boolean isModifiable)
public ComponentTypePropDefn(java.lang.String name, java.lang.String displayName, PropertyType type, boolean required)
Method Detail |
---|
public java.lang.String getName()
getName
in interface ObjectDefinition
public java.lang.String getDisplayName()
getDisplayName
in interface ObjectDefinition
public java.lang.String getShortDescription()
getShortDescription
in interface ObjectDefinition
public boolean isRequired()
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.
isRequired
in interface PropertyDefinition
public PropertyDefinition.RestartType getRequiresRestart()
PropertyDefinition
getRequiresRestart
in interface PropertyDefinition
PropertyDefinition.getRequiresRestart()
public boolean isMasked()
isMasked
in interface PropertyDefinition
public boolean isModifiable()
isModifiable
in interface PropertyDefinition
public boolean isExpert()
isExpert
in interface PropertyDefinition
public PropertyType getPropertyType()
getPropertyType
in interface PropertyDefinition
public java.lang.Object getDefaultValue()
getDefaultValue
in interface PropertyDefinition
hasDefaultValue()
public java.util.List getAllowedValues()
getAllowedValues
in interface PropertyDefinition
#hasAllowedValues
public boolean hasDefaultValue()
hasDefaultValue
in interface PropertyDefinition
getDefaultValue()
public boolean isConstrainedToAllowedValues()
PropertyDefinition
isConstrainedToAllowedValues
in interface PropertyDefinition
#hasAllowedValues
,
PropertyDefinition.getAllowedValues()
public java.lang.String getShortDisplayName()
getShortDisplayName
in interface ObjectDefinition
public java.lang.String getPluralDisplayName()
getPluralDisplayName
in interface ObjectDefinition
public int compareTo(java.lang.Object obj)
Note: this method is consistent with
equals()
, meaning that
(compare(x, y)==0) == (x.equals(y))
.
compareTo
in interface ObjectDefinition
compareTo
in interface java.lang.Comparable
obj
- the object that this instance is to be compared to.
java.lang.IllegalArgumentException
- if the specified object reference is null
java.lang.ClassCastException
- if the specified object's type prevents it
from being compared to this instance.public boolean equals(java.lang.Object obj)
compareTo()
.
equals
in interface ObjectDefinition
equals
in class java.lang.Object
obj
- the object that this instance is to be compared to.
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in interface ObjectDefinition
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |