public class FeatureDescriptor extends Object
It supports some common information that can be set and retrieved for any of the introspection descriptors.
In addition it provides an extension mechanism so that arbitrary attribute/value pairs can be associated with a design feature.
Constructor and Description |
---|
FeatureDescriptor()
Constructs a
FeatureDescriptor . |
Modifier and Type | Method and Description |
---|---|
Enumeration<String> |
attributeNames()
Gets an enumeration of the locale-independent names of this
feature.
|
String |
getDisplayName()
Gets the localized display name of this feature.
|
String |
getName()
Gets the programmatic name of this feature.
|
String |
getShortDescription()
Gets the short description of this feature.
|
Object |
getValue(String attributeName)
Retrieve a named attribute with this feature.
|
boolean |
isExpert()
The "expert" flag is used to distinguish between those features that are
intended for expert users from those that are intended for normal users.
|
boolean |
isHidden()
The "hidden" flag is used to identify features that are intended only
for tool use, and which should not be exposed to humans.
|
boolean |
isPreferred()
The "preferred" flag is used to identify features that are particularly
important for presenting to humans.
|
void |
setDisplayName(String displayName)
Sets the localized display name of this feature.
|
void |
setExpert(boolean expert)
The "expert" flag is used to distinguish between features that are
intended for expert users from those that are intended for normal users.
|
void |
setHidden(boolean hidden)
The "hidden" flag is used to identify features that are intended only
for tool use, and which should not be exposed to humans.
|
void |
setName(String name)
Sets the programmatic name of this feature.
|
void |
setPreferred(boolean preferred)
The "preferred" flag is used to identify features that are particularly
important for presenting to humans.
|
void |
setShortDescription(String text)
You can associate a short descriptive string with a feature.
|
void |
setValue(String attributeName,
Object value)
Associate a named attribute with this feature.
|
String |
toString()
Returns a string representation of the object.
|
public String getName()
public void setName(String name)
name
- The programmatic name of the property/method/eventpublic String getDisplayName()
public void setDisplayName(String displayName)
displayName
- The localized display name for the
property/method/event.public boolean isExpert()
public void setExpert(boolean expert)
expert
- True if this feature is intended for use by experts only.public boolean isHidden()
public void setHidden(boolean hidden)
hidden
- True if this feature should be hidden from human users.public boolean isPreferred()
public void setPreferred(boolean preferred)
preferred
- True if this feature should be preferentially shown
to human users.public String getShortDescription()
public void setShortDescription(String text)
text
- A (localized) short description to be associated with
this property/method/event.public void setValue(String attributeName, Object value)
attributeName
- The locale-independent name of the attributevalue
- The value.public Object getValue(String attributeName)
attributeName
- The locale-independent name of the attributepublic Enumeration<String> attributeNames()
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved.