org.clapper.util.classutil

Class FieldInfo

java.lang.Object

org.clapper.util.classutil.FieldInfo

public class FieldInfo
extends java.lang.Object

Holds information about a field within a class.

See Also:

ClassInfo

Constructor Summary

Constructors

Constructor and Description
FieldInfo() Create a new, empty FieldInfo object.
FieldInfo(int access, java.lang.String name, java.lang.String description, java.lang.String signature, java.lang.Object value) Create and initialize a new FieldInfo object.

Method Summary

Modifier and Type	Method and Description
int	compareTo(FieldInfo other) Compare this object and another FieldInfo object.
boolean	equals(java.lang.Object other) Compare this object to another one for equality.
int	getAccess() Get the access modifiers for this field
java.lang.String	getDescription() Get the field description, if any.
java.lang.String	getName() Get the field name.
java.lang.String	getSignature() Get the field's signature, if any.
java.lang.Object	getValue() Get the field value, if any.
int	hashCode() Get the hash code.
java.lang.String	toString() Return a string representation of the method.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldInfo

public FieldInfo()

Create a new, empty FieldInfo object.

FieldInfo

public FieldInfo(int access,
                 java.lang.String name,
                 java.lang.String description,
                 java.lang.String signature,
                 java.lang.Object value)

Create and initialize a new FieldInfo object.

Parameters:

access - field access modifiers, etc.

name - field name

description - field description

signature - field signature

value - field value, if any

Method Detail

getAccess

public int getAccess()

Get the access modifiers for this field

Returns:

the access modifiers, or 0 if none are set.

getName

public java.lang.String getName()

Get the field name.

Returns:

the field name

getDescription

public java.lang.String getDescription()

Get the field description, if any.

Returns:

the field description, or null

getSignature

public java.lang.String getSignature()

Get the field's signature, if any.

Returns:

the field signature, or null.

getValue

public java.lang.Object getValue()

Get the field value, if any.

Returns:

the field value, or null.

hashCode

public int hashCode()

Get the hash code. The hash code is based on the field's name.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code

compareTo

public int compareTo(FieldInfo other)

Compare this object and another FieldInfo object. The two objects are compared by their signature fields.

Parameters:

other - the other object

Returns:

a negative integer, zero, or a positive integer, as this object is less than, equal to, or greater than the specified object.

equals

public boolean equals(java.lang.Object other)

Compare this object to another one for equality. If the other object is a FieldInfo instance, the two will be compared by signature.

Overrides:

equals in class java.lang.Object

Parameters:

other - the other object

Returns:

true if other is a FieldInfo object and it has the same signature as this object, false otherwise.

toString

public java.lang.String toString()

Return a string representation of the method. Currently, the string representation is just the method's signature, or the name if the signature is null.

Overrides:

toString in class java.lang.Object

Returns:

a string representation