|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PropertyType
The interface that describes the nature of a property.
Method Summary | |
---|---|
Object |
getDefaultValue()
Returns the default value for this property. |
Class |
getType()
Returns the Java type represented by the property. |
Object[] |
getValidValues()
Returns an array of valid values that can be set on this property. |
String[] |
getValidValuesAsStrings()
Returns an array of the valid String values that can be set on this property. |
boolean |
isExpert()
Indicates if this property is an Expert or Advanced property. |
boolean |
isHidden()
Indicates if this property is a hidden one. |
boolean |
isPrimitive()
Indicates if this property is a primitive type. |
boolean |
isReadOnly()
Indicates if this property is a read only one that should not be set or altered. |
boolean |
isRequired()
Indicates that a user must set a value for this property. |
boolean |
isSensitive()
Indicates if the property contents should be displayed in a obsfucated manner. |
boolean |
isValidValuesEditable()
Indicates whether the list of valid values returned from getValidValues() , or getValidValuesAsStrings() , are
the only possible set of values for the property. |
Method Detail |
---|
Class getType()
int
is wrapped by java.lang.Integer
)
null
class of the Java type represented by
the property.boolean isHidden()
boolean isReadOnly()
boolean isExpert()
If it is a commonly set property this should return false
.
boolean isPrimitive()
java.lang.Integer
Object getDefaultValue()
null
if no default exists.Object[] getValidValues()
null
if there are no recommended values for the
property. Tool environments must also check the
isValidValuesEditable()
method if this method returns a non
null
array of recommended values. If
isValidValueseEditable() returns false
then the array of
recommended values returned by this method are the only possible set of
values for the property.
null
if there are no recommended values
for the property.isValidValuesEditable()
boolean isSensitive()
Consumers of sensitive properties should never persist the values without
taking appropriate security measures such as encryption. An example would
be a
ConnectionPersistence
implementation storing the password value of a particular connection
configuration.
boolean isRequired()
String[] getValidValuesAsStrings()
getValidValues()
.
null
if there are no recommended values
for the property.method.
,
MultiValuedProperty.addValueAsString(String)
boolean isValidValuesEditable()
getValidValues()
, or getValidValuesAsStrings()
, are
the only possible set of values for the property. In other words, can
values other than the set of defined valid values be used to set on the
property. This information can be used by user interfaces to decide
whether to show the property as an editable combo box or a non-editable
one for example.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |