org.apache.xml.utils.synthetic.reflection
Class Field

java.lang.Object
  org.apache.xml.utils.synthetic.reflection.Field

All Implemented Interfaces:

Member

public class Field

extends Object

implements Member

A Field provides information about, and dynamic access to, a single field of a class or an interface. The reflected field may be a class (static) field or an instance field.

A Field permits widening conversions to occur during a get or set access operation, but throws an IllegalArgumentException if a narrowing conversion would occur.

Field Summary

(package private) Class	declaringClass Field declaringClass, type
String	initializer Field name, initializer
(package private) int	modifiers Field modifiers
String	name Field name, initializer
(package private) Field	realfield Field realfield
(package private) Class	type Field declaringClass, type

Constructor Summary

Field(Field realfield, Class declaringClass)
Proxy constructor

Field(String name, Class declaringClass)
Synthesis constructor

Method Summary

boolean	equals(Object obj) Compares this Field against the specified object.
Object	get(Object obj) Returns the value of the field represented by this Field, on the specified object.
boolean	getBoolean(Object obj) Get the value of a field as a boolean on specified object.
byte	getByte(Object obj) Get the value of a field as a byte on specified object.
char	getChar(Object obj) Get the value of a field as a char on specified object.
Class	getDeclaringClass() Returns the Class object representing the class or interface that declares the field represented by this Field object.
double	getDouble(Object obj) Get the value of a field as a double on specified object.
float	getFloat(Object obj) Get the value of a field as a float on specified object.
String	getInitializer() Method getInitializer (getInitializer) @return
int	getInt(Object obj) Get the value of a field as a int on specified object.
long	getLong(Object obj) Get the value of a field as a long on specified object.
int	getModifiers() Returns the Java language modifiers for the field represented by this Field object, as an integer.
String	getName() Insert the method's description here.
short	getShort(Object obj) Get the value of a field as a short on specified object.
Class	getType() Returns a Class object that identifies the declared type for the field represented by this Field object.
int	hashCode() Returns a hashcode for this Field.
void	set(Object obj, Object value) Sets the field represented by this Field object on the specified object argument to the specified new value.
void	setBoolean(Object obj, boolean z) Set the value of a field as a boolean on specified object.
void	setByte(Object obj, byte b) Set the value of a field as a byte on specified object.
void	setChar(Object obj, char c) Set the value of a field as a char on specified object.
void	setDeclaringClass(Class declaringClass) Returns the Class object representing the class that declares the constructor represented by this Constructor object.
void	setDouble(Object obj, double d) Set the value of a field as a double on specified object.
void	setFloat(Object obj, float f) Set the value of a field as a float on specified object.
void	setInitializer(String i) Method setInitializer
void	setInt(Object obj, int i) Set the value of a field as an int on specified object.
void	setLong(Object obj, long l) Set the value of a field as a long on specified object.
void	setModifiers(int modifiers) Insert the method's description here.
void	setShort(Object obj, short s) Set the value of a field as a short on specified object.
void	setType(Class type) Method setType
String	toSource() Output the Field as Java sourcecode
String	toString() Return a string describing this Field.

Methods inherited from class java.lang.Object

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

Field Detail

name

public String name

Field name, initializer

initializer

public String initializer

Field name, initializer

modifiers

int modifiers

Field modifiers

realfield

Field realfield

Field realfield

declaringClass

Class declaringClass

Field declaringClass, type

type

Class type

Field declaringClass, type

Constructor Detail

Field

public Field(Field realfield,
             Class declaringClass)

Proxy constructor

Parameters:

realfield -

declaringClass -

Field

public Field(String name,
             Class declaringClass)

Synthesis constructor

Parameters:

name -

declaringClass -

Method Detail

equals

public boolean equals(Object obj)

Compares this Field against the specified object. Returns true if the objects are the same. Two Fields are the same if they were declared by the same class and have the same name and type.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), Hashtable

get

public Object get(Object obj)
           throws IllegalArgumentException,
                  IllegalAccessException

Returns the value of the field represented by this Field, on the specified object. The value is automatically wrapped in an object if it has a primitive type.

The underlying field's value is obtained as follows:

If the underlying field is a static field, the object argument is ignored; it may be null.

Otherwise, the underlying field is an instance field. If the specified object argument is null, the method throws a NullPointerException. If the specified object is not an instance of the class or interface declaring the underlying field, the method throws an IllegalArgumentException.

If this Field object enforces Java language access control, and the underlying field is inaccessible, the method throws an IllegalAccessException.

Otherwise, the value is retrieved from the underlying instance or static field. If the field has a primitive type, the value is wrapped in an object before being returned, otherwise it is returned as is.

Parameters:

obj -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the specified object is not an instance of the class or interface declaring the underlying field.

NullPointerException - if the specified object is null.

getBoolean

public boolean getBoolean(Object obj)
                   throws IllegalArgumentException,
                          IllegalAccessException

Get the value of a field as a boolean on specified object.

Parameters:

obj -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the field value cannot be converted to the return type by a widening conversion.

getByte

public byte getByte(Object obj)
             throws IllegalArgumentException,
                    IllegalAccessException

Get the value of a field as a byte on specified object.

Parameters:

obj -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the field value cannot be converted to the return type by a widening conversion.

getChar

public char getChar(Object obj)
             throws IllegalArgumentException,
                    IllegalAccessException

Get the value of a field as a char on specified object.

Parameters:

obj -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the field value cannot be converted to the return type by a widening conversion.

getDeclaringClass

public Class getDeclaringClass()

Returns the Class object representing the class or interface that declares the field represented by this Field object.

Specified by:

getDeclaringClass in interface Member

getDouble

public double getDouble(Object obj)
                 throws IllegalArgumentException,
                        IllegalAccessException

Get the value of a field as a double on specified object.

Parameters:

obj -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the field value cannot be converted to the return type by a widening conversion.

getFloat

public float getFloat(Object obj)
               throws IllegalArgumentException,
                      IllegalAccessException

Get the value of a field as a float on specified object.

Parameters:

obj -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the field value cannot be converted to the return type by a widening conversion.

getInt

public int getInt(Object obj)
           throws IllegalArgumentException,
                  IllegalAccessException

Get the value of a field as a int on specified object.

Parameters:

obj -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the field value cannot be converted to the return type by a widening conversion.

getLong

public long getLong(Object obj)
             throws IllegalArgumentException,
                    IllegalAccessException

Get the value of a field as a long on specified object.

Parameters:

obj -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the field value cannot be converted to the return type by a widening conversion.

getModifiers

public int getModifiers()

Returns the Java language modifiers for the field represented by this Field object, as an integer. The Modifier class should be used to decode the modifiers.

Specified by:

getModifiers in interface Member

getInitializer

public String getInitializer()

Method getInitializer (getInitializer) @return

setInitializer

public void setInitializer(String i)
                    throws SynthesisException

Method setInitializer

Parameters:

i -

Throws:

SynthesisException

getName

public String getName()

Insert the method's description here. Creation date: (12-25-99 2:02:26 PM)

Returns:

java.lang.String

getShort

public short getShort(Object obj)
               throws IllegalArgumentException,
                      IllegalAccessException

Get the value of a field as a short on specified object.

Parameters:

obj -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the field value cannot be converted to the return type by a widening conversion.

getType

public Class getType()

Returns a Class object that identifies the declared type for the field represented by this Field object.

setType

public void setType(Class type)
             throws SynthesisException

Method setType

Parameters:

type -

Throws:

SynthesisException

hashCode

public int hashCode()

Returns a hashcode for this Field. This is computed as the exclusive-or of the hashcodes for the underlying field's declaring class name and its name.

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

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

set

public void set(Object obj,
                Object value)
         throws IllegalArgumentException,
                IllegalAccessException

Sets the field represented by this Field object on the specified object argument to the specified new value. The new value is automatically unwrapped if the underlying field has a primitive type. The operation proceeds as follows: If the underlying field is static, the object argument is ignored; it may be null. Otherwise the underlying field is an instance field. If the specified object argument is null, the method throws a NullPointerException. If the specified object argument is not an instance of the class or interface declaring the underlying field, the method throws an IllegalArgumentException. If this Field object enforces Java language access control, and the underlying field is inaccessible, the method throws an IllegalAccessException. If the underlying field is final, the method throws an IllegalAccessException. If the underlying field is of a primitive type, an unwrapping conversion is attempted to convert the new value to a value of a primitive type. If this attempt fails, the method throws an IllegalArgumentException. If, after possible unwrapping, the new value cannot be converted to the type of the underlying field by an identity or widening conversion, the method throws an IllegalArgumentException. The field is set to the possibly unwrapped and widened new value.

Parameters:

obj -

value -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the specified object is not an instance of the class or interface declaring the underlying field, or if an unwrapping conversion fails.

NullPointerException - if the specified object is null.

setBoolean

public void setBoolean(Object obj,
                       boolean z)
                throws IllegalArgumentException,
                       IllegalAccessException

Set the value of a field as a boolean on specified object.

Parameters:

obj -

z -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the specified object is not an instance of the class or interface declaring the underlying field, or if an unwrapping conversion fails.

setByte

public void setByte(Object obj,
                    byte b)
             throws IllegalArgumentException,
                    IllegalAccessException

Set the value of a field as a byte on specified object.

Parameters:

obj -

b -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the specified object is not an instance of the class or interface declaring the underlying field, or if an unwrapping conversion fails.

setChar

public void setChar(Object obj,
                    char c)
             throws IllegalArgumentException,
                    IllegalAccessException

Set the value of a field as a char on specified object.

Parameters:

obj -

c -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the specified object is not an instance of the class or interface declaring the underlying field, or if an unwrapping conversion fails.

setDeclaringClass

public void setDeclaringClass(Class declaringClass)

Returns the Class object representing the class that declares the constructor represented by this Constructor object.

Specified by:

setDeclaringClass in interface Member

Parameters:

declaringClass -

setDouble

public void setDouble(Object obj,
                      double d)
               throws IllegalArgumentException,
                      IllegalAccessException

Set the value of a field as a double on specified object.

Parameters:

obj -

d -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the specified object is not an instance of the class or interface declaring the underlying field, or if an unwrapping conversion fails.

setFloat

public void setFloat(Object obj,
                     float f)
              throws IllegalArgumentException,
                     IllegalAccessException

Set the value of a field as a float on specified object.

Parameters:

obj -

f -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the specified object is not an instance of the class or interface declaring the underlying field, or if an unwrapping conversion fails.

setInt

public void setInt(Object obj,
                   int i)
            throws IllegalArgumentException,
                   IllegalAccessException

Set the value of a field as an int on specified object.

Parameters:

obj -

i -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the specified object is not an instance of the class or interface declaring the underlying field, or if an unwrapping conversion fails.

setLong

public void setLong(Object obj,
                    long l)
             throws IllegalArgumentException,
                    IllegalAccessException

Set the value of a field as a long on specified object.

Parameters:

obj -

l -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the specified object is not an instance of the class or interface declaring the underlying field, or if an unwrapping conversion fails.

setModifiers

public void setModifiers(int modifiers)
                  throws SynthesisException

Insert the method's description here. Creation date: (12-25-99 1:28:28 PM)

Specified by:

setModifiers in interface Member

Parameters:

modifiers - int

Returns:

int

Throws:

SynthesisException

setShort

public void setShort(Object obj,
                     short s)
              throws IllegalArgumentException,
                     IllegalAccessException

Set the value of a field as a short on specified object.

Parameters:

obj -

s -

Throws:

IllegalAccessException - if the underlying constructor is inaccessible.

IllegalArgumentException - if the specified object is not an instance of the class or interface declaring the underlying field, or if an unwrapping conversion fails.

toString

public String toString()

Return a string describing this Field. The format is the access modifiers for the field, if any, followed by the field type, followed by a space, followed by the fully-qualified name of the class declaring the field, followed by a period, followed by the name of the field. For example: public static final int java.lang.Thread.MIN_PRIORITY private int java.io.FileDescriptor.fd The modifiers are placed in canonical order as specified by "The Java Language Specification". This is public, protected or private first, and then other modifiers in the following order: static, final, transient, volatile.

Overrides:

toString in class Object

Returns:

a string representation of the object.

toSource

public String toSource()

Output the Field as Java sourcecode