public class FeatureDescriptor extends Object
Documentation Convention: for proper Internalization of Beans inside an RAD tool, sometimes there are two names for a property or method: a programmatic, or locale-independent name, which can be used anywhere, and a localized, display name, for ease of use. In the documentation I will specify different String values as either programmatic or localized to make this distinction clear.
Constructor and Description |
---|
FeatureDescriptor()
Instantiate this FeatureDescriptor with appropriate default values.
|
Modifier and Type | Method and Description |
---|---|
Enumeration<String> |
attributeNames()
Get a list of the programmatic key names set with setValue().
|
String |
getDisplayName()
Get the localized (display) name of this feature.
|
String |
getName()
Get the programmatic name of this feature.
|
String |
getShortDescription()
Get the localized short description for this feature.
|
Object |
getValue(String name)
Get an arbitrary value set with setValue().
|
boolean |
isExpert()
Indicates whether this feature is for expert use only.
|
boolean |
isHidden()
Indicates whether this feature is for use by tools only.
|
boolean |
isPreferred() |
void |
setDisplayName(String displayName)
Set the localized (display) name of this feature.
|
void |
setExpert(boolean expert)
Set whether this feature is for expert use only.
|
void |
setHidden(boolean hidden)
Set whether this feature is for use by tools only.
|
void |
setName(String name)
Set the programmatic name of this feature.
|
void |
setPreferred(boolean preferred) |
void |
setShortDescription(String shortDescription)
Set the localized short description for this feature.
|
void |
setValue(String name,
Object value)
Set an arbitrary string-value pair with this feature.
|
public FeatureDescriptor()
public void setName(String name)
name
- the new name for this feature.public String getDisplayName()
public void setDisplayName(String displayName)
displayName
- the new display name for this feature.public String getShortDescription()
public void setShortDescription(String shortDescription)
shortDescription
- the new short description for this feature.public boolean isExpert()
public void setExpert(boolean expert)
expert
- true if for use by experts only,
or false if anyone can use it.public boolean isHidden()
public void setHidden(boolean hidden)
hidden
- true if tools only should use it,
or false if anyone can see it.public boolean isPreferred()
public void setPreferred(boolean preferred)
public Object getValue(String name)
name
- the programmatic name of the key.public void setValue(String name, Object value)
name
- the programmatic name of the key.value
- the value to associate with the name.public Enumeration<String> attributeNames()