java::lang::reflect::Field Class Reference

A Field provides information about, and dynamic access to, a single field of a class or an interface. More...

#include <java_lang_reflect_Field.h>

Inheritance diagram for java::lang::reflect::Field:

[legend]Collaboration diagram for java::lang::reflect::Field:

[legend]List of all members.

Public Types
enum	{   xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9,   xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::java::lang::reflect::Field >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::java::lang::reflect::Field > >	array2D
Public Member Functions
bool	equals (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Compares this Field against the specified object.
	Field (const ::java::lang::Class &declaringClass, const ::java::lang::String &name, const ::java::lang::Class &type, jint modifiers, jint slot,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Package-private constructor used by ReflectAccess to enable instantiation of these objects in Java code from the java.lang package via sun.reflect.LangReflectAccess.
::java::lang::Object	get (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the value of the field represented by this Field, on the specified object.
bool	getBoolean (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the value of a static or instance boolean field.
jbyte	getByte (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the value of a static or instance byte field.
jchar	getChar (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the value of a static or instance field of type char or of another primitive type convertible to type char via a widening conversion.
::java::lang::Class	getDeclaringClass (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the Class object representing the class or interface that declares the field represented by this Field object.
jdouble	getDouble (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the value of a static or instance field of type double or of another primitive type convertible to type double via a widening conversion.
jfloat	getFloat (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the value of a static or instance field of type float or of another primitive type convertible to type float via a widening conversion.
jint	getInt (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the value of a static or instance field of type int or of another primitive type convertible to type int via a widening conversion.
jlong	getLong (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the value of a static or instance field of type long or of another primitive type convertible to type long via a widening conversion.
jint	getModifiers (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the Java language modifiers for the field represented by this Field object, as an integer.
::java::lang::String	getName (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the name of the field represented by this Field object.
jshort	getShort (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the value of a static or instance field of type short or of another primitive type convertible to type short via a widening conversion.
::java::lang::Class	getType (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a Class object that identifies the declared type for the field represented by this Field object.
jint	hashCode (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a hashcode for this Field.
void	set (const ::java::lang::Object &obj, const ::java::lang::Object &value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Sets the field represented by this Field object on the specified object argument to the specified new value.
void	setBoolean (const ::java::lang::Object &obj, bool z,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Sets the value of a field as a boolean on the specified object.
void	setByte (const ::java::lang::Object &obj, jbyte b,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Sets the value of a field as a byte on the specified object.
void	setChar (const ::java::lang::Object &obj, jchar c,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Sets the value of a field as a char on the specified object.
void	setDouble (const ::java::lang::Object &obj, jdouble d,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Sets the value of a field as a double on the specified object.
void	setFloat (const ::java::lang::Object &obj, jfloat f,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Sets the value of a field as a float on the specified object.
void	setInt (const ::java::lang::Object &obj, jint i,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Sets the value of a field as an int on the specified object.
void	setLong (const ::java::lang::Object &obj, jlong l,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Sets the value of a field as a long on the specified object.
void	setShort (const ::java::lang::Object &obj, jshort s,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Sets the value of a field as a short on the specified object.
::java::lang::String	toString (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a string describing this Field.

---

Detailed Description

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.

Author:

Kenneth Russell

Nakul Saraiya

---

Constructor & Destructor Documentation

java::lang::reflect::Field::Field (  const ::java::lang::Class &  declaringClass, const ::java::lang::String &  name, const ::java::lang::Class &  type, jint  modifiers, jint  slot, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Package-private constructor used by ReflectAccess to enable instantiation of these objects in Java code from the java.lang package via sun.reflect.LangReflectAccess. Parameters: declaringClass  a reference to an outer class instance. name  a reference to an outer class instance. type  a reference to an outer class instance. modifiers  a reference to an outer class instance. slot  a reference to an outer class instance. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

---

Member Function Documentation

bool java::lang::reflect::Field::equals (  const ::java::lang::Object &  obj, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Compares this Field against the specified object. Returns true if the objects are the same. Two Field objects are the same if they were declared by the same class and have the same name and type. Parameters: obj  a reference to an outer class instance. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::Object.

::java::lang::Object java::lang::reflect::Field::get (  const ::java::lang::Object &  obj, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

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 obj argument is ignored; it may be null. Otherwise, the underlying field is an instance field. If the specified obj 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. If the underlying field is static, the class that declared the field is initialized if it has not already been initialized. 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. If the field is hidden in the type of obj, the field's value is obtained according to the preceding rules. Parameters: obj  object from which the represented field's value is to be extracted p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the value of the represented field in object obj; primitive values are wrapped in an appropriate object before being returned

bool java::lang::reflect::Field::getBoolean (  const ::java::lang::Object &  obj, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Gets the value of a static or instance boolean field. Parameters: obj  the object to extract the boolean value from p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the value of the boolean field

jbyte java::lang::reflect::Field::getByte (  const ::java::lang::Object &  obj, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Gets the value of a static or instance byte field. Parameters: obj  the object to extract the byte value from p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the value of the byte field

jchar java::lang::reflect::Field::getChar (  const ::java::lang::Object &  obj, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Gets the value of a static or instance field of type char or of another primitive type convertible to type char via a widening conversion. Parameters: obj  the object to extract the char value from p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the value of the field converted to type char

::java::lang::Class java::lang::reflect::Field::getDeclaringClass (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns the Class object representing the class or interface that declares the field represented by this Field object. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::reflect::Member.

jdouble java::lang::reflect::Field::getDouble (  const ::java::lang::Object &  obj, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Gets the value of a static or instance field of type double or of another primitive type convertible to type double via a widening conversion. Parameters: obj  the object to extract the double value from p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the value of the field converted to type double

jfloat java::lang::reflect::Field::getFloat (  const ::java::lang::Object &  obj, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Gets the value of a static or instance field of type float or of another primitive type convertible to type float via a widening conversion. Parameters: obj  the object to extract the float value from p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the value of the field converted to type float

jint java::lang::reflect::Field::getInt (  const ::java::lang::Object &  obj, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Gets the value of a static or instance field of type int or of another primitive type convertible to type int via a widening conversion. Parameters: obj  the object to extract the int value from p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the value of the field converted to type int

jlong java::lang::reflect::Field::getLong (  const ::java::lang::Object &  obj, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Gets the value of a static or instance field of type long or of another primitive type convertible to type long via a widening conversion. Parameters: obj  the object to extract the long value from p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the value of the field converted to type long

jint java::lang::reflect::Field::getModifiers (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

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. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::reflect::Member.

::java::lang::String java::lang::reflect::Field::getName (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns the name of the field represented by this Field object. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::reflect::Member.

jshort java::lang::reflect::Field::getShort (  const ::java::lang::Object &  obj, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Gets the value of a static or instance field of type short or of another primitive type convertible to type short via a widening conversion. Parameters: obj  the object to extract the short value from p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the value of the field converted to type short

::java::lang::Class java::lang::reflect::Field::getType (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns a Class object that identifies the declared type for the field represented by this Field object. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: a Class object identifying the declared type of the field represented by this object

jint java::lang::reflect::Field::hashCode (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

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. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::Object.

void java::lang::reflect::Field::set (  const ::java::lang::Object &  obj, const ::java::lang::Object &  value, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

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 obj 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. If the underlying field is static, the class that declared the field is initialized if it has not already been initialized. The field is set to the possibly unwrapped and widened new value. If the field is hidden in the type of obj, the field's value is set according to the preceding rules. Parameters: obj  the object whose field should be modified value  the new value for the field of obj being modified p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

void java::lang::reflect::Field::setBoolean (  const ::java::lang::Object &  obj, bool  z, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Sets the value of a field as a boolean on the specified object. This method is equivalent to set(obj, zObj), where zObj is a Boolean object and zObj.booleanValue() == z. Parameters: obj  the object whose field should be modified z  the new value for the field of obj being modified p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

void java::lang::reflect::Field::setByte (  const ::java::lang::Object &  obj, jbyte  b, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Sets the value of a field as a byte on the specified object. This method is equivalent to set(obj, bObj), where bObj is a Byte object and bObj.byteValue() == b. Parameters: obj  the object whose field should be modified b  the new value for the field of obj being modified p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

void java::lang::reflect::Field::setChar (  const ::java::lang::Object &  obj, jchar  c, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Sets the value of a field as a char on the specified object. This method is equivalent to set(obj, cObj), where cObj is a Character object and cObj.charValue() == c. Parameters: obj  the object whose field should be modified c  the new value for the field of obj being modified p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

void java::lang::reflect::Field::setDouble (  const ::java::lang::Object &  obj, jdouble  d, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Sets the value of a field as a double on the specified object. This method is equivalent to set(obj, dObj), where dObj is a Double object and dObj.doubleValue() == d. Parameters: obj  the object whose field should be modified d  the new value for the field of obj being modified p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

void java::lang::reflect::Field::setFloat (  const ::java::lang::Object &  obj, jfloat  f, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Sets the value of a field as a float on the specified object. This method is equivalent to set(obj, fObj), where fObj is a Float object and fObj.floatValue() == f. Parameters: obj  the object whose field should be modified f  the new value for the field of obj being modified p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

void java::lang::reflect::Field::setInt (  const ::java::lang::Object &  obj, jint  i, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Sets the value of a field as an int on the specified object. This method is equivalent to set(obj, iObj), where iObj is a Integer object and iObj.intValue() == i. Parameters: obj  the object whose field should be modified i  the new value for the field of obj being modified p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

void java::lang::reflect::Field::setLong (  const ::java::lang::Object &  obj, jlong  l, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Sets the value of a field as a long on the specified object. This method is equivalent to set(obj, lObj), where lObj is a Long object and lObj.longValue() == l. Parameters: obj  the object whose field should be modified l  the new value for the field of obj being modified p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

void java::lang::reflect::Field::setShort (  const ::java::lang::Object &  obj, jshort  s, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Sets the value of a field as a short on the specified object. This method is equivalent to set(obj, sObj), where sObj is a Short object and sObj.shortValue() == s. Parameters: obj  the object whose field should be modified s  the new value for the field of obj being modified p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

::java::lang::String java::lang::reflect::Field::toString (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns 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. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::Object.

---

The documentation for this class was generated from the following file:

• java_lang_reflect_Field.h

---