java.beans

Class FeatureDescriptor

Known Direct Subclasses:
BeanDescriptor, EventSetDescriptor, MethodDescriptor, ParameterDescriptor, PropertyDescriptor

public class FeatureDescriptor
extends Object

FeatureDescriptor is the common superclass for all JavaBeans Descriptor classes. JavaBeans descriptors are abstract descriptors of properties, events, methods, beans, etc.

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.

Since:
1.1

Constructor Summary

FeatureDescriptor()
Instantiate this FeatureDescriptor with appropriate default values.

Method Summary

Enumeration
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.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FeatureDescriptor

public FeatureDescriptor()
Instantiate this FeatureDescriptor with appropriate default values.

Method Details

attributeNames

public Enumeration attributeNames()
Get a list of the programmatic key names set with setValue().
Returns:
an Enumerator over all the programmatic key names associated with this feature.

getDisplayName

public String getDisplayName()
Get the localized (display) name of this feature.

getName

public String getName()
Get the programmatic name of this feature.

getShortDescription

public String getShortDescription()
Get the localized short description for this feature.

getValue

public Object getValue(String name)
Get an arbitrary value set with setValue().
Parameters:
name - the programmatic name of the key.
Returns:
the value associated with this name, or null if there is none.

isExpert

public boolean isExpert()
Indicates whether this feature is for expert use only.
Returns:
true if for use by experts only, or false if anyone can use it.

isHidden

public boolean isHidden()
Indicates whether this feature is for use by tools only. If it is for use by tools only, then it should not be displayed.
Returns:
true if tools only should use it, or false if anyone can see it.

isPreferred

public boolean isPreferred()

setDisplayName

public void setDisplayName(String displayName)
Set the localized (display) name of this feature.
Parameters:
displayName - the new display name for this feature.

setExpert

public void setExpert(boolean expert)
Set whether this feature is for expert use only.
Parameters:
expert - true if for use by experts only, or false if anyone can use it.

setHidden

public void setHidden(boolean hidden)
Set whether this feature is for use by tools only. If it is for use by tools only, then it should not be displayed.
Parameters:
hidden - true if tools only should use it, or false if anyone can see it.

setName

public void setName(String name)
Set the programmatic name of this feature.
Parameters:
name - the new name for this feature.

setPreferred

public void setPreferred(boolean preferred)

setShortDescription

public void setShortDescription(String shortDescription)
Set the localized short description for this feature.
Parameters:
shortDescription - the new short description for this feature.

setValue

public void setValue(String name,
                     Object value)
Set an arbitrary string-value pair with this feature.
Parameters:
name - the programmatic name of the key.
value - the value to associate with the name.

java.beans.FeatureDescriptor Copyright (C) 1998, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.