| |
|
| java.lang.Object java.lang.reflect.AccessibleObject java.lang.reflect.Field
Constructor Summary | |
| Field(Class declaringClass, String name, Class type, int modifiers, int slot, String signature, byte[] annotations) Package-private constructor used by ReflectAccess to enable
instantiation of these objects in Java code from the java.lang
package via sun.reflect.LangReflectAccess. |
Method Summary | |
Field | copy() Package-private routine (exposed to java.lang.Class via
ReflectAccess) which returns a copy of this Field. | public boolean | equals(Object obj) Compares this
Field against the specified object. | public Object | get(Object obj) Returns the value of the field represented by this
Field , on
the specified object. | public T | getAnnotation(Class<T> annotationClass) | public boolean | getBoolean(Object obj) Gets the value of a static or instance
boolean field. | public byte | getByte(Object obj) Gets the value of a static or instance
byte field. | public char | getChar(Object obj) 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. | public Annotation[] | getDeclaredAnnotations() | public Class> | getDeclaringClass() Returns the
Class object representing the class or interface
that declares the field represented by this
Field object. | public double | getDouble(Object obj) 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. | public float | getFloat(Object obj) 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. | public Type | getGenericType() Returns a
Type object that represents the declared type for
the field represented by this
Field object.
If the
Type is a parameterized type, the
Type object returned must accurately reflect the
actual type parameters used in the source code.
If the type of the underlying field is a type variable or a
parameterized type, it is created. | public int | getInt(Object obj) 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. | public long | getLong(Object obj) 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. | public int | getModifiers() Returns the Java language modifiers for the field represented
by this
Field object, as an integer. | public String | getName() Returns the name of the field represented by this
Field object. | public short | getShort(Object obj) 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. | public Class> | getType() Returns a
Class object that identifies the
declared type for the field represented by this
Field object. | static String | getTypeName(Class type) | public int | hashCode() Returns a hashcode for this
Field . | public boolean | isEnumConstant() Returns
true if this field represents an element of
an enumerated type; returns
false otherwise. | public boolean | isSynthetic() Returns
true if this field is a synthetic
field; returns
false otherwise. | public void | set(Object obj, Object value) Sets the field represented by this
Field object on the
specified object argument to the specified new value. | public void | setBoolean(Object obj, boolean z) Sets the value of a field as a
boolean on the specified object. | public void | setByte(Object obj, byte b) Sets the value of a field as a
byte on the specified object. | public void | setChar(Object obj, char c) Sets the value of a field as a
char on the specified object. | public void | setDouble(Object obj, double d) Sets the value of a field as a
double on the specified object. | public void | setFloat(Object obj, float f) Sets the value of a field as a
float on the specified object. | public void | setInt(Object obj, int i) Sets the value of a field as an
int on the specified object. | public void | setLong(Object obj, long l) Sets the value of a field as a
long on the specified object. | public void | setShort(Object obj, short s) Sets the value of a field as a
short on the specified object. | public String | toGenericString() Returns a string describing this
Field , including
its generic type. | public String | toString() Returns a string describing this
Field . |
Field | Field(Class declaringClass, String name, Class type, int modifiers, int slot, String signature, byte[] annotations)(Code) | | Package-private constructor used by ReflectAccess to enable
instantiation of these objects in Java code from the java.lang
package via sun.reflect.LangReflectAccess.
|
copy | Field copy()(Code) | | Package-private routine (exposed to java.lang.Class via
ReflectAccess) which returns a copy of this Field. The copy's
"root" field points to this Field.
|
equals | public boolean equals(Object obj)(Code) | | 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.
|
get | public Object get(Object obj) throws IllegalArgumentException, IllegalAccessException(Code) | | 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 isto be extracted the value of the represented field in object obj ; primitive values are wrapped in an appropriateobject before being returned exception: IllegalAccessException - if the underlying fieldis inaccessible. exception: IllegalArgumentException - if the specified object is not aninstance of the class or interface declaring the underlyingfield (or a subclass or implementor thereof). exception: NullPointerException - if the specified object is nulland the field is an instance field. exception: ExceptionInInitializerError - if the initialization provokedby this method fails. |
getBoolean | public boolean getBoolean(Object obj) throws IllegalArgumentException, IllegalAccessException(Code) | | Gets the value of a static or instance
boolean field.
Parameters: obj - the object to extract the boolean valuefrom the value of the boolean field exception: IllegalAccessException - if the underlying fieldis inaccessible. exception: IllegalArgumentException - if the specified object is not an instance of the class or interface declaring theunderlying field (or a subclass or implementor thereof), or if the field value cannot beconverted to the type boolean by a widening conversion. exception: NullPointerException - if the specified object is nulland the field is an instance field. exception: ExceptionInInitializerError - if the initialization provokedby this method fails. See Also: Field.get |
getChar | public char getChar(Object obj) throws IllegalArgumentException, IllegalAccessException(Code) | | 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 valuefrom the value of the field converted to type char exception: IllegalAccessException - if the underlying fieldis inaccessible. exception: IllegalArgumentException - if the specified object is not an instance of the class or interface declaring theunderlying field (or a subclass or implementor thereof), or if the field value cannot beconverted to the type char by a widening conversion. exception: NullPointerException - if the specified object is nulland the field is an instance field. exception: ExceptionInInitializerError - if the initialization provokedby this method fails. See Also: Field.get |
getDeclaredAnnotations | public Annotation[] getDeclaredAnnotations()(Code) | | since: 1.5 |
getDeclaringClass | public Class> getDeclaringClass()(Code) | | Returns the
Class object representing the class or interface
that declares the field represented by this
Field object.
|
getDouble | public double getDouble(Object obj) throws IllegalArgumentException, IllegalAccessException(Code) | | 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 valuefrom the value of the field converted to type double exception: IllegalAccessException - if the underlying fieldis inaccessible. exception: IllegalArgumentException - if the specified object is not an instance of the class or interface declaring theunderlying field (or a subclass or implementor thereof), or if the field value cannot beconverted to the type double by a widening conversion. exception: NullPointerException - if the specified object is nulland the field is an instance field. exception: ExceptionInInitializerError - if the initialization provokedby this method fails. See Also: Field.get |
getFloat | public float getFloat(Object obj) throws IllegalArgumentException, IllegalAccessException(Code) | | 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 valuefrom the value of the field converted to type float exception: IllegalAccessException - if the underlying fieldis inaccessible. exception: IllegalArgumentException - if the specified object is not an instance of the class or interface declaring theunderlying field (or a subclass or implementor thereof), or if the field value cannot beconverted to the type float by a widening conversion. exception: NullPointerException - if the specified object is nulland the field is an instance field. exception: ExceptionInInitializerError - if the initialization provokedby this method fails. See Also: Field.get |
getGenericType | public Type getGenericType()(Code) | | Returns a
Type object that represents the declared type for
the field represented by this
Field object.
If the
Type is a parameterized type, the
Type object returned must accurately reflect the
actual type parameters used in the source code.
If the type of the underlying field is a type variable or a
parameterized type, it is created. Otherwise, it is resolved.
a Type object that represents the declared type forthe field represented by this Field object throws: GenericSignatureFormatError - if the generic fieldsignature does not conform to the format specified in the JavaVirtual Machine Specification, 3rd edition throws: TypeNotPresentException - if the generic typesignature of the underlying field refers to a non-existenttype declaration throws: MalformedParameterizedTypeException - if the genericsignature of the underlying field refers to a parameterized typethat cannot be instantiated for any reason since: 1.5 |
getInt | public int getInt(Object obj) throws IllegalArgumentException, IllegalAccessException(Code) | | 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 valuefrom the value of the field converted to type int exception: IllegalAccessException - if the underlying fieldis inaccessible. exception: IllegalArgumentException - if the specified object is not an instance of the class or interface declaring theunderlying field (or a subclass or implementor thereof), or if the field value cannot beconverted to the type int by a widening conversion. exception: NullPointerException - if the specified object is nulland the field is an instance field. exception: ExceptionInInitializerError - if the initialization provokedby this method fails. See Also: Field.get |
getLong | public long getLong(Object obj) throws IllegalArgumentException, IllegalAccessException(Code) | | 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 valuefrom the value of the field converted to type long exception: IllegalAccessException - if the underlying fieldis inaccessible. exception: IllegalArgumentException - if the specified object is not an instance of the class or interface declaring theunderlying field (or a subclass or implementor thereof), or if the field value cannot beconverted to the type long by a widening conversion. exception: NullPointerException - if the specified object is nulland the field is an instance field. exception: ExceptionInInitializerError - if the initialization provokedby this method fails. See Also: Field.get |
getModifiers | public int getModifiers()(Code) | | 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.
See Also: Modifier |
getName | public String getName()(Code) | | Returns the name of the field represented by this
Field object.
|
getShort | public short getShort(Object obj) throws IllegalArgumentException, IllegalAccessException(Code) | | 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 valuefrom the value of the field converted to type short exception: IllegalAccessException - if the underlying fieldis inaccessible. exception: IllegalArgumentException - if the specified object is not an instance of the class or interface declaring theunderlying field (or a subclass or implementor thereof), or if the field value cannot beconverted to the type short by a widening conversion. exception: NullPointerException - if the specified object is nulland the field is an instance field. exception: ExceptionInInitializerError - if the initialization provokedby this method fails. See Also: Field.get |
getType | public Class> getType()(Code) | | Returns a
Class object that identifies the
declared type for the field represented by this
Field object.
a Class object identifying the declaredtype of the field represented by this object |
hashCode | public int hashCode()(Code) | | 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.
|
isEnumConstant | public boolean isEnumConstant()(Code) | | Returns
true if this field represents an element of
an enumerated type; returns
false otherwise.
true if and only if this field represents an element ofan enumerated type. since: 1.5 |
isSynthetic | public boolean isSynthetic()(Code) | | Returns
true if this field is a synthetic
field; returns
false otherwise.
true if and only if this field is a syntheticfield as defined by the Java Language Specification. since: 1.5 |
set | public void set(Object obj, Object value) throws IllegalArgumentException, IllegalAccessException(Code) | | 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 unless
setAccessible(true) has succeeded for this field
and this field is non-static. Setting a final field in this way
is meaningful only during deserialization or reconstruction of
instances of classes with blank final fields, before they are
made available for access by other parts of a program. Use in
any other context may have unpredictable effects, including cases
in which other parts of a program continue to use the original
value of this field.
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 Parameters: value - the new value for the field of obj being modified exception: IllegalAccessException - if the underlying fieldis inaccessible. exception: IllegalArgumentException - if the specified object is not aninstance of the class or interface declaring the underlyingfield (or a subclass or implementor thereof), or if an unwrapping conversion fails. exception: NullPointerException - if the specified object is nulland the field is an instance field. exception: ExceptionInInitializerError - if the initialization provokedby this method fails. |
setBoolean | public void setBoolean(Object obj, boolean z) throws IllegalArgumentException, IllegalAccessException(Code) | | 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 Parameters: z - the new value for the field of obj being modified exception: IllegalAccessException - if the underlying fieldis inaccessible. exception: IllegalArgumentException - if the specified object is not aninstance of the class or interface declaring the underlyingfield (or a subclass or implementor thereof), or if an unwrapping conversion fails. exception: NullPointerException - if the specified object is nulland the field is an instance field. exception: ExceptionInInitializerError - if the initialization provokedby this method fails. See Also: Field.set |
setByte | public void setByte(Object obj, byte b) throws IllegalArgumentException, IllegalAccessException(Code) | | 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 Parameters: b - the new value for the field of obj being modified exception: IllegalAccessException - if the underlying fieldis inaccessible. exception: IllegalArgumentException - if the specified object is not aninstance of the class or interface declaring the underlyingfield (or a subclass or implementor thereof), or if an unwrapping conversion fails. exception: NullPointerException - if the specified object is nulland the field is an instance field. exception: ExceptionInInitializerError - if the initialization provokedby this method fails. See Also: Field.set |
setChar | public void setChar(Object obj, char c) throws IllegalArgumentException, IllegalAccessException(Code) | | 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 Parameters: c - the new value for the field of obj being modified exception: IllegalAccessException - if the underlying fieldis inaccessible. exception: IllegalArgumentException - if the specified object is not aninstance of the class or interface declaring the underlyingfield (or a subclass or implementor thereof), or if an unwrapping conversion fails. exception: NullPointerException - if the specified object is nulland the field is an instance field. exception: ExceptionInInitializerError - if the initialization provokedby this method fails. See Also: Field.set |
setDouble | public void setDouble(Object obj, double d) throws IllegalArgumentException, IllegalAccessException(Code) | | 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 Parameters: d - the new value for the field of obj being modified exception: IllegalAccessException - if the underlying fieldis inaccessible. exception: IllegalArgumentException - if the specified object is not aninstance of the class or interface declaring the underlyingfield (or a subclass or implementor thereof), or if an unwrapping conversion fails. exception: NullPointerException - if the specified object is nulland the field is an instance field. exception: ExceptionInInitializerError - if the initialization provokedby this method fails. See Also: Field.set |
setFloat | public void setFloat(Object obj, float f) throws IllegalArgumentException, IllegalAccessException(Code) | | 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 Parameters: f - the new value for the field of obj being modified exception: IllegalAccessException - if the underlying fieldis inaccessible. exception: IllegalArgumentException - if the specified object is not aninstance of the class or interface declaring the underlyingfield (or a subclass or implementor thereof), or if an unwrapping conversion fails. exception: NullPointerException - if the specified object is nulland the field is an instance field. exception: ExceptionInInitializerError - if the initialization provokedby this method fails. See Also: Field.set |
setInt | public void setInt(Object obj, int i) throws IllegalArgumentException, IllegalAccessException(Code) | | 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 Parameters: i - the new value for the field of obj being modified exception: IllegalAccessException - if the underlying fieldis inaccessible. exception: IllegalArgumentException - if the specified object is not aninstance of the class or interface declaring the underlyingfield (or a subclass or implementor thereof), or if an unwrapping conversion fails. exception: NullPointerException - if the specified object is nulland the field is an instance field. exception: ExceptionInInitializerError - if the initialization provokedby this method fails. See Also: Field.set |
setLong | public void setLong(Object obj, long l) throws IllegalArgumentException, IllegalAccessException(Code) | | 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 Parameters: l - the new value for the field of obj being modified exception: IllegalAccessException - if the underlying fieldis inaccessible. exception: IllegalArgumentException - if the specified object is not aninstance of the class or interface declaring the underlyingfield (or a subclass or implementor thereof), or if an unwrapping conversion fails. exception: NullPointerException - if the specified object is nulland the field is an instance field. exception: ExceptionInInitializerError - if the initialization provokedby this method fails. See Also: Field.set |
setShort | public void setShort(Object obj, short s) throws IllegalArgumentException, IllegalAccessException(Code) | | 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 Parameters: s - the new value for the field of obj being modified exception: IllegalAccessException - if the underlying fieldis inaccessible. exception: IllegalArgumentException - if the specified object is not aninstance of the class or interface declaring the underlyingfield (or a subclass or implementor thereof), or if an unwrapping conversion fails. exception: NullPointerException - if the specified object is nulland the field is an instance field. exception: ExceptionInInitializerError - if the initialization provokedby this method fails. See Also: Field.set |
toGenericString | public String toGenericString()(Code) | | Returns a string describing this
Field , including
its generic type. The format is the access modifiers for the
field, if any, followed by the generic 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.
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 .
a string describing this Field , includingits generic type since: 1.5 |
toString | public String toString()(Code) | | 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 .
|
|
|
|