FileDocCategorySizeDatePackage
Field.javaAPI DocJava SE 5 API41609Fri Aug 26 14:57:06 BST 2005java.lang.reflect

Field

public final class Field extends AccessibleObject 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.

see
Member
see
java.lang.Class
see
java.lang.Class#getFields()
see
java.lang.Class#getField(String)
see
java.lang.Class#getDeclaredFields()
see
java.lang.Class#getDeclaredField(String)
author
Kenneth Russell
author
Nakul Saraiya

Fields Summary
private Class
clazz
private int
slot
private String
name
private Class
type
private int
modifiers
private transient String
signature
private transient FieldRepository
genericInfo
private byte[]
annotations
private sun.reflect.FieldAccessor
fieldAccessor
private sun.reflect.FieldAccessor
overrideFieldAccessor
private Field
root
private volatile Class
securityCheckTargetClassCache
private static final Annotation[]
EMPTY_ANNOTATION_ARRAY
private transient Map
declaredAnnotations
Constructors 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.

        this.clazz = declaringClass;
        this.name = name;
        this.type = type;
        this.modifiers = modifiers;
        this.slot = slot;
        this.signature = signature;
        this.annotations = annotations;
    
Methods Summary
private sun.reflect.FieldAccessoracquireFieldAccessor(boolean overrideFinalCheck)

        // First check to see if one has been created yet, and take it
        // if so
        FieldAccessor tmp = null;
        if (root != null) tmp = root.getFieldAccessor(overrideFinalCheck);
        if (tmp != null) {
            if (overrideFinalCheck)
                overrideFieldAccessor = tmp;
            else
                fieldAccessor = tmp;
        } else {
            // Otherwise fabricate one and propagate it up to the root
            tmp = reflectionFactory.newFieldAccessor(this, overrideFinalCheck);
            setFieldAccessor(tmp, overrideFinalCheck);
        }
        return tmp;
    
java.lang.reflect.Fieldcopy()
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.

        // This routine enables sharing of FieldAccessor objects
        // among Field objects which refer to the same underlying
        // method in the VM. (All of this contortion is only necessary
        // because of the "accessibility" bit in AccessibleObject,
        // which implicitly requires that new java.lang.reflect
        // objects be fabricated for each reflective call on Class
        // objects.)
        Field res = new Field(clazz, name, type, modifiers, slot, signature, annotations);
        res.root = this;
        // Might as well eagerly propagate this if already present
        res.fieldAccessor = fieldAccessor;
        res.overrideFieldAccessor = overrideFieldAccessor;
        return res;
    
private synchronized java.util.MapdeclaredAnnotations()

        if (declaredAnnotations == null) {
            declaredAnnotations = AnnotationParser.parseAnnotations(
                annotations, sun.misc.SharedSecrets.getJavaLangAccess().
                getConstantPool(getDeclaringClass()),
                getDeclaringClass());
        }
        return declaredAnnotations;
    
private voiddoSecurityCheck(java.lang.Object obj)

        if (!override) {
            if (!Reflection.quickCheckMemberAccess(clazz, modifiers)) {
                Class caller = Reflection.getCallerClass(4);
                Class targetClass = ((obj == null || !Modifier.isProtected(modifiers))
                                     ? clazz
                                     : obj.getClass());
                if (securityCheckCache != caller ||
                    targetClass != securityCheckTargetClassCache) {
                    Reflection.ensureMemberAccess(caller, clazz, obj, modifiers);
                    securityCheckCache = caller;
                    securityCheckTargetClassCache = targetClass;
                }
            }
        }
    
public booleanequals(java.lang.Object obj)
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.

	if (obj != null && obj instanceof Field) {
	    Field other = (Field)obj;
	    return (getDeclaringClass() == other.getDeclaringClass())
                && (getName() == other.getName())
		&& (getType() == other.getType());
	}
	return false;
    
public java.lang.Objectget(java.lang.Object obj)
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.

param
obj object from which the represented field's value is to be extracted
return
the value of the represented field in object obj; primitive values are wrapped in an appropriate object before being returned
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof).
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.

        return getFieldAccessor(obj).get(obj);
    
public TgetAnnotation(java.lang.Class annotationClass)

        if (annotationClass == null)
            throw new NullPointerException();

        return (T) declaredAnnotations().get(annotationClass);
    
public booleangetBoolean(java.lang.Object obj)
Gets the value of a static or instance boolean field.

param
obj the object to extract the boolean value from
return
the value of the boolean field
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if the field value cannot be converted to the type boolean by a widening conversion.
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.
see
Field#get

        return getFieldAccessor(obj).getBoolean(obj);
    
public bytegetByte(java.lang.Object obj)
Gets the value of a static or instance byte field.

param
obj the object to extract the byte value from
return
the value of the byte field
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if the field value cannot be converted to the type byte by a widening conversion.
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.
see
Field#get

        return getFieldAccessor(obj).getByte(obj);
    
public chargetChar(java.lang.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.

param
obj the object to extract the char value from
return
the value of the field converted to type char
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if the field value cannot be converted to the type char by a widening conversion.
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.
see
Field#get

        return getFieldAccessor(obj).getChar(obj);
    
public java.lang.annotation.Annotation[]getDeclaredAnnotations()


        
        return declaredAnnotations().values().toArray(EMPTY_ANNOTATION_ARRAY);
    
public java.lang.ClassgetDeclaringClass()
Returns the Class object representing the class or interface that declares the field represented by this Field object.

	return clazz;
    
public doublegetDouble(java.lang.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.

param
obj the object to extract the double value from
return
the value of the field converted to type double
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if the field value cannot be converted to the type double by a widening conversion.
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.
see
Field#get

        return getFieldAccessor(obj).getDouble(obj);
    
private sun.reflect.generics.factory.GenericsFactorygetFactory()

	Class<?> c = getDeclaringClass();
	// create scope and factory
	return CoreReflectionFactory.make(c, ClassScope.make(c)); 
    
private sun.reflect.FieldAccessorgetFieldAccessor(java.lang.Object obj)

        doSecurityCheck(obj);
        boolean ov = override;
        FieldAccessor a = (ov)? overrideFieldAccessor : fieldAccessor;
        return (a != null)? a : acquireFieldAccessor(ov);
    
private sun.reflect.FieldAccessorgetFieldAccessor(boolean overrideFinalCheck)

        return (overrideFinalCheck)? overrideFieldAccessor : fieldAccessor;
    
public floatgetFloat(java.lang.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.

param
obj the object to extract the float value from
return
the value of the field converted to type float
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if the field value cannot be converted to the type float by a widening conversion.
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.
see
Field#get

        return getFieldAccessor(obj).getFloat(obj);
    
private sun.reflect.generics.repository.FieldRepositorygetGenericInfo()

	// lazily initialize repository if necessary
	if (genericInfo == null) {
	    // create and cache generic info repository
	    genericInfo = FieldRepository.make(getGenericSignature(), 
					       getFactory());
	}
	return genericInfo; //return cached repository
    
private java.lang.StringgetGenericSignature()

return signature;
public java.lang.reflect.TypegetGenericType()
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 an the type of the underlying field is a type variable or a parameterized type, it is created. Otherwise, it is resolved.

return
a Type object that represents the declared type for the field represented by this Field object
throws
GenericSignatureFormatError if the generic field signature does not conform to the format specified in the Java Virtual Machine Specification, 3rd edition
throws
TypeNotPresentException if the generic type signature of the underlying field refers to a non-existent type declaration
throws
MalformedParameterizedTypeException if the generic signature of the underlying field refers to a parameterized type that cannot be instantiated for any reason
since
1.5

	if (getGenericSignature() != null)
	    return getGenericInfo().getGenericType();
	else
	    return getType();
    
public intgetInt(java.lang.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.

param
obj the object to extract the int value from
return
the value of the field converted to type int
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if the field value cannot be converted to the type int by a widening conversion.
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.
see
Field#get

        return getFieldAccessor(obj).getInt(obj);
    
public longgetLong(java.lang.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.

param
obj the object to extract the long value from
return
the value of the field converted to type long
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if the field value cannot be converted to the type long by a widening conversion.
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.
see
Field#get

        return getFieldAccessor(obj).getLong(obj);
    
public intgetModifiers()
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
Modifier

	return modifiers;
    
public java.lang.StringgetName()
Returns the name of the field represented by this Field object.

	return name;
    
public shortgetShort(java.lang.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.

param
obj the object to extract the short value from
return
the value of the field converted to type short
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if the field value cannot be converted to the type short by a widening conversion.
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.
see
Field#get

        return getFieldAccessor(obj).getShort(obj);
    
public java.lang.ClassgetType()
Returns a Class object that identifies the declared type for the field represented by this Field object.

return
a Class object identifying the declared type of the field represented by this object

	return type;
    
static java.lang.StringgetTypeName(java.lang.Class type)

	if (type.isArray()) {
	    try {
		Class cl = type;
		int dimensions = 0;
		while (cl.isArray()) {
		    dimensions++;
		    cl = cl.getComponentType();
		}
		StringBuffer sb = new StringBuffer();
		sb.append(cl.getName());
		for (int i = 0; i < dimensions; i++) {
		    sb.append("[]");
		}
		return sb.toString();
	    } catch (Throwable e) { /*FALLTHRU*/ }
	}
	return type.getName();
    
public inthashCode()
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.

	return getDeclaringClass().getName().hashCode() ^ getName().hashCode();
    
public booleanisEnumConstant()
Returns true if this field represents an element of an enumerated type; returns false otherwise.

return
true if and only if this field represents an element of an enumerated type.
since
1.5

        return (getModifiers() & Modifier.ENUM) != 0;
    
public booleanisSynthetic()
Returns true if this field is a synthetic field; returns false otherwise.

return
true if and only if this field is a synthetic field as defined by the Java Language Specification.
since
1.5

        return Modifier.isSynthetic(getModifiers());
    
public voidset(java.lang.Object obj, java.lang.Object value)
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.

param
obj the object whose field should be modified
param
value the new value for the field of obj being modified
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails.
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.

        getFieldAccessor(obj).set(obj, value);
    
public voidsetBoolean(java.lang.Object obj, boolean z)
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.

param
obj the object whose field should be modified
param
z the new value for the field of obj being modified
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails.
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.
see
Field#set

        getFieldAccessor(obj).setBoolean(obj, z);
    
public voidsetByte(java.lang.Object obj, byte b)
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.

param
obj the object whose field should be modified
param
b the new value for the field of obj being modified
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails.
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.
see
Field#set

        getFieldAccessor(obj).setByte(obj, b);
    
public voidsetChar(java.lang.Object obj, char c)
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.

param
obj the object whose field should be modified
param
c the new value for the field of obj being modified
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails.
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.
see
Field#set

        getFieldAccessor(obj).setChar(obj, c);
    
public voidsetDouble(java.lang.Object obj, double d)
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.

param
obj the object whose field should be modified
param
d the new value for the field of obj being modified
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails.
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.
see
Field#set

        getFieldAccessor(obj).setDouble(obj, d);
    
private voidsetFieldAccessor(sun.reflect.FieldAccessor accessor, boolean overrideFinalCheck)

        if (overrideFinalCheck)
            overrideFieldAccessor = accessor;
        else
            fieldAccessor = accessor;
        // Propagate up
        if (root != null) {
            root.setFieldAccessor(accessor, overrideFinalCheck);
        }
    
public voidsetFloat(java.lang.Object obj, float f)
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.

param
obj the object whose field should be modified
param
f the new value for the field of obj being modified
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails.
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.
see
Field#set

        getFieldAccessor(obj).setFloat(obj, f);
    
public voidsetInt(java.lang.Object obj, int i)
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.

param
obj the object whose field should be modified
param
i the new value for the field of obj being modified
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails.
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.
see
Field#set

        getFieldAccessor(obj).setInt(obj, i);
    
public voidsetLong(java.lang.Object obj, long l)
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.

param
obj the object whose field should be modified
param
l the new value for the field of obj being modified
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails.
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.
see
Field#set

        getFieldAccessor(obj).setLong(obj, l);
    
public voidsetShort(java.lang.Object obj, short s)
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.

param
obj the object whose field should be modified
param
s the new value for the field of obj being modified
exception
IllegalAccessException if the underlying field is inaccessible.
exception
IllegalArgumentException if the specified object is not an instance of the class or interface declaring the underlying field (or a subclass or implementor thereof), or if an unwrapping conversion fails.
exception
NullPointerException if the specified object is null and the field is an instance field.
exception
ExceptionInInitializerError if the initialization provoked by this method fails.
see
Field#set

        getFieldAccessor(obj).setShort(obj, s);
    
public java.lang.StringtoGenericString()
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.

return
a string describing this Field, including its generic type
since
1.5

	int mod = getModifiers();
	Type fieldType = getGenericType();
	return (((mod == 0) ? "" : (Modifier.toString(mod) + " "))
	    +  ((fieldType instanceof Class) ?
		getTypeName((Class)fieldType): fieldType.toString())+ " "
	    + getTypeName(getDeclaringClass()) + "."
	    + getName());
    
public java.lang.StringtoString()
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.

	int mod = getModifiers();
	return (((mod == 0) ? "" : (Modifier.toString(mod) + " "))
	    + getTypeName(getType()) + " "
	    + getTypeName(getDeclaringClass()) + "."
	    + getName());