FeatureDescriptor

public class FeatureDescriptor extends Object
Known Direct Subclasses
Known Indirect Subclasses

Common base class for Descriptors.

Public Constructor Summary

FeatureDescriptor()

Constructs an instance.

Public Method Summary

Enumeration<String>
attributeNames()

Enumerates the attribute names.

String
getDisplayName()

Gets the display name or getName() if not set.

String
getName()

Gets the name.

String
getShortDescription()

Gets the short description or getDisplayName() if not set.

Object
getValue(String attributeName)

Gets the value associated with the named attribute.

boolean
isExpert()

Indicates if this feature is an expert feature.

boolean
isHidden()

Indicates if this feature is hidden.

boolean
isPreferred()

Indicates if this feature is preferred.

void
setDisplayName(String displayName)

Sets the display name.

void
setExpert(boolean expert)

Sets the expert indicator.

void
setHidden(boolean hidden)

Sets the hidden indicator.

void
setName(String name)

Sets the name.

void
setPreferred(boolean preferred)

Sets the preferred indicator.

void
setShortDescription(String text)

Sets the short description.

void
setValue(String attributeName, Object value)

Sets the value for the named attribute.

Inherited Method Summary

Public Constructors

public FeatureDescriptor ()

Constructs an instance.

Public Methods

public Enumeration<String> attributeNames ()

Enumerates the attribute names.

Returns

public String getDisplayName ()

Gets the display name or getName() if not set.

Returns
  • The display name.

public String getName ()

Gets the name.

Returns
  • The name.

public String getShortDescription ()

Gets the short description or getDisplayName() if not set.

Returns
  • The description.

public Object getValue (String attributeName)

Gets the value associated with the named attribute.

Parameters
attributeName The name of the attribute to get a value for.
Returns
  • The attribute's value.

public boolean isExpert ()

Indicates if this feature is an expert feature.

Returns
  • true if hidden, false otherwise.

public boolean isHidden ()

Indicates if this feature is hidden.

Returns
  • true if hidden, false otherwise.

public boolean isPreferred ()

Indicates if this feature is preferred.

Returns
  • true if preferred, false otherwise.

public void setDisplayName (String displayName)

Sets the display name.

Parameters
displayName The display name to set.

public void setExpert (boolean expert)

Sets the expert indicator.

Parameters
expert true if expert, false otherwise.

public void setHidden (boolean hidden)

Sets the hidden indicator.

Parameters
hidden true if hidden, false otherwise.

public void setName (String name)

Sets the name.

Parameters
name The name to set.

public void setPreferred (boolean preferred)

Sets the preferred indicator.

Parameters
preferred true if preferred, false otherwise.

public void setShortDescription (String text)

Sets the short description.

Parameters
text The description to set.

public void setValue (String attributeName, Object value)

Sets the value for the named attribute.

Parameters
attributeName The name of the attribute to set a value with.
value The value to set.