net.lenni0451.optconfig.access.types

Interface FieldAccess

All Known Implementing Classes:

DummyFieldAccess, MethodHandleFieldAccess, ReflectionFieldAccess

public interface FieldAccess

A field which can be accessed by optconfig (e.g. using reflection).

Method Summary

Modifier and Type	Method and Description
default <T> T	castValue(java.lang.Object instance) Get the value of the field from the given instance and cast it to the wanted type.
<T extends java.lang.annotation.Annotation> T	getAnnotation(java.lang.Class<T> annotationClass) Get an annotation of the field.
int	getModifiers()
java.lang.String	getName()
java.lang.Class<?>	getType()
java.lang.Object	getValue(java.lang.Object instance) Get the value of the field from the given instance.
void	setValue(java.lang.Object instance, java.lang.Object value) Set the value of the field for the given instance.

Method Detail

getName

java.lang.String getName()

Returns:

The name of the field

See Also:

Field.getName()

getType

java.lang.Class<?> getType()

Returns:

The type of the field

See Also:

Field.getType()

getModifiers

int getModifiers()

Returns:

The modifiers of the field

See Also:

Field.getModifiers()

getValue

java.lang.Object getValue(java.lang.Object instance)

Get the value of the field from the given instance.

Parameters:

instance - The instance to get the value from

Returns:

The value of the field

See Also:

Field.get(Object)

castValue

default <T> T castValue(java.lang.Object instance)

Get the value of the field from the given instance and cast it to the wanted type.

Type Parameters:

T - The type to cast the value to

Parameters:

instance - The instance to get the value from

Returns:

The value of the field

Throws:

java.lang.ClassCastException - If the value cannot be casted to the wanted type

setValue

void setValue(java.lang.Object instance,
              java.lang.Object value)

Set the value of the field for the given instance.

Parameters:

instance - The instance to set the value for

value - The value to set

See Also:

Field.set(Object, Object)

getAnnotation

<T extends java.lang.annotation.Annotation> T getAnnotation(java.lang.Class<T> annotationClass)

Get an annotation of the field.

Type Parameters:

T - The type of the annotation

Parameters:

annotationClass - The class of the annotation

Returns:

The annotation or null if the field does not have this annotation

See Also:

AccessibleObject.getDeclaredAnnotation(Class)