/*******************************************************************************
* Copyright 2011 See AUTHORS file.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
******************************************************************************/
package com.artemis.utils.reflect;
import java.util.Arrays;
import com.artemis.gwtref.client.ReflectionCache;
import com.artemis.gwtref.client.Type;
import com.artemis.utils.reflect.ReflectionException;
/** Provides information about, and access to, a single field of a class or interface.
* @author nexsoftware */
public final class Field {
private final com.artemis.gwtref.client.Field field;
Field (com.artemis.gwtref.client.Field field) {
this.field = field;
}
/** Returns the name of the field. */
public String getName () {
return field.getName();
}
/** Returns a Class object that identifies the declared type for the field. */
public Class getType () {
return field.getType().getClassOfType();
}
/** Returns the Class object representing the class or interface that declares the field. */
public Class getDeclaringClass () {
return field.getEnclosingType().getClassOfType();
}
public boolean isAccessible () {
return field.isPublic();
}
public void setAccessible (boolean accessible) {
// NOOP in GWT
}
/** Return true if the field does not include any of the {@code private}, {@code protected}, or {@code public} modifiers. */
public boolean isDefaultAccess () {
return !isPrivate() && !isProtected() && !isPublic();
}
/** Return true if the field includes the {@code final} modifier. */
public boolean isFinal () {
return field.isFinal();
}
/** Return true if the field includes the {@code private} modifier. */
public boolean isPrivate () {
return field.isPrivate();
}
/** Return true if the field includes the {@code protected} modifier. */
public boolean isProtected () {
return field.isProtected();
}
/** Return true if the field includes the {@code public} modifier. */
public boolean isPublic () {
return field.isPublic();
}
/** Return true if the field includes the {@code static} modifier. */
public boolean isStatic () {
return field.isStatic();
}
/** Return true if the field includes the {@code transient} modifier. */
public boolean isTransient () {
return field.isTransient();
}
/** Return true if the field includes the {@code volatile} modifier. */
public boolean isVolatile () {
return field.isVolatile();
}
/** Return true if the field is a synthetic field. */
public boolean isSynthetic () {
return field.isSynthetic();
}
/** If the type of the field is parameterized, returns the Class object representing the parameter type at the specified index,
* null otherwise. */
public Class getElementType (int index) {
Type elementType = field.getElementType(index);
return elementType != null ? elementType.getClassOfType() : null;
}
/** Returns the value of the field on the supplied object. */
public Object get (Object obj) throws ReflectionException {
try {
return field.get(obj);
} catch (IllegalArgumentException e) {
throw new ReflectionException("Could not get " + getDeclaringClass() + "#" + getName() + ": " + e.getMessage(), e);
} catch (IllegalAccessException e) {
throw new ReflectionException("Illegal access to field " + getName() + ": " + e.getMessage(), e);
}
}
/** Sets the value of the field on the supplied object. */
public void set (Object obj, Object value) throws ReflectionException {
try {
field.set(obj, value);
} catch (IllegalArgumentException e) {
throw new ReflectionException("Could not set " + getDeclaringClass() + "#" + getName() + ": " + e.getMessage(), e);
} catch (IllegalAccessException e) {
throw new ReflectionException("Illegal access to field " + getName() + ": " + e.getMessage(), e);
}
}
@SuppressWarnings("rawtypes")
@Deprecated
public boolean hasAnnotation(Class annotationClass) {
return isAnnotationPresent(annotationClass);
}
/** Returns this element's annotation for the specified type if such an annotation is present, else null. */
@Deprecated
public <T extends java.lang.annotation.Annotation>T getAnnotation(Class<T> annotationClass) {
final Annotation declaredAnnotation = getDeclaredAnnotation(annotationClass);
return declaredAnnotation != null ? declaredAnnotation.getAnnotation(annotationClass) : null;
}
/** Returns true if the field includes an annotation of the provided class type. */
public boolean isAnnotationPresent (Class<? extends java.lang.annotation.Annotation> annotationType) {
java.lang.annotation.Annotation[] annotations = field.getDeclaredAnnotations();
for (java.lang.annotation.Annotation annotation : annotations) {
if (annotation.annotationType().equals(annotationType)) {
return true;
}
}
return false;
}
/** Returns an array of {@link Annotation} objects reflecting all annotations declared by this field,
* or an empty array if there are none. Does not include inherited annotations. */
public Annotation[] getDeclaredAnnotations () {
java.lang.annotation.Annotation[] annotations = field.getDeclaredAnnotations();
Annotation[] result = new Annotation[annotations.length];
for (int i = 0; i < annotations.length; i++) {
result[i] = new Annotation(annotations[i]);
}
return result;
}
/** Returns an {@link Annotation} object reflecting the annotation provided, or null of this field doesn't
* have such an annotation. This is a convenience function if the caller knows already which annotation
* type he's looking for. */
public Annotation getDeclaredAnnotation (Class<? extends java.lang.annotation.Annotation> annotationType) {
java.lang.annotation.Annotation[] annotations = field.getDeclaredAnnotations();
for (java.lang.annotation.Annotation annotation : annotations) {
if (annotation.annotationType().equals(annotationType)) {
return new Annotation(annotation);
}
}
return null;
}
}