org.jfox.mx
Class MxFeatureInfo

java.lang.Object
  org.jfox.mx.MxFeatureInfo

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

MxConstructorInfo, MxOperationInfo, MxParameterInfo

public class MxFeatureInfo

extends java.lang.Object

implements java.io.Serializable

See Also:

Serialized Form

Field Summary

protected java.lang.String	description The human-readable description of the feature.
protected java.lang.String	name The name of the feature.

Constructor Summary

MxFeatureInfo(java.lang.String name, java.lang.String description)
Constructs an MxFeatureInfo object.

Method Summary

boolean	equals(java.lang.Object o) Compare this MxFeatureInfo to another.
java.lang.String	getDescription() Returns the human-readable description of the feature.
java.lang.String	getName() Returns the name of the feature.
int	hashCode() Returns a hash code value for the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected java.lang.String name

The name of the feature. It is recommended that subclasses call getName() rather than reading this field, and that they not change it.

description

protected java.lang.String description

The human-readable description of the feature. It is recommended that subclasses call getDescription() rather than reading this field, and that they not change it.

Constructor Detail

MxFeatureInfo

public MxFeatureInfo(java.lang.String name,
                     java.lang.String description)
              throws java.lang.IllegalArgumentException

Constructs an MxFeatureInfo object.

Parameters:

name - The name of the feature.

description - A human readable description of the feature.

Throws:

java.lang.IllegalArgumentException - if name is not a valid Java identifier. Java reserved words are not considered illegal here.

Method Detail

getName

public java.lang.String getName()

Returns the name of the feature.

Returns:

the name of the feature.

getDescription

public java.lang.String getDescription()

Returns the human-readable description of the feature.

Returns:

the human-readable description of the feature.

equals

public boolean equals(java.lang.Object o)

Compare this MxFeatureInfo to another.

Parameters:

o - the object to compare to.

Returns:

true iff o is an MxFeatureInfo such that its getName() and getDescription() values are equal (not necessarily identical) to those of this MxFeatureInfo.

See Also:

Object.hashCode(), Hashtable

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable