com.comphenix.protocol.reflect

Class StructureModifier<TField>

java.lang.Object

com.comphenix.protocol.reflect.StructureModifier<TField>

public class StructureModifier<TField>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
StructureModifier(java.lang.Class targetType, java.lang.Class superclassExclude, boolean requireDefault) Creates a structure modifier.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.reflect.Field>	getFields() Retrieves a list of the fields matching the constraints of this structure modifier.
java.lang.Class	getFieldType() Retrieves the common type of each field.
java.lang.Object	getTarget() Retrieves the object we're currently modifying.
java.lang.Class	getTargetType() Retrieves the type of the object we're modifying.
java.util.List<TField>	getValues() Retrieve every value stored in the fields of the current type.
StructureModifier<TField>	modify(int fieldIndex, com.google.common.base.Function<TField,TField> select) Correctly modifies the value of a field.
TField	read(int fieldIndex) Reads the value of a field given its index.
TField	readSafely(int fieldIndex) Reads the value of a field if and ONLY IF it exists.
int	size() Retrieve the number of readable types.
StructureModifier<TField>	withTarget(java.lang.Object target) Retrieves a structure modifier of the same type for a different object target.
<T> StructureModifier<T>	withType(java.lang.Class fieldType) Retrieves a structure modifier that only reads and writes fields of a given type.
<T> StructureModifier<T>	withType(java.lang.Class fieldType, EquivalentConverter<T> converter) Retrieves a structure modifier that only reads and writes fields of a given type.
StructureModifier<TField>	write(int fieldIndex, TField value) Writes the value of a field given its index.
StructureModifier<TField>	writeDefaults() Sets all non-primitive fields to a more fitting default value.
StructureModifier<TField>	writeSafely(int fieldIndex, TField value) Writes the value of a given field IF and ONLY if it exists.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StructureModifier

public StructureModifier(java.lang.Class targetType,
                 java.lang.Class superclassExclude,
                 boolean requireDefault)

Creates a structure modifier.

Parameters:

targetType - - the structure to modify.

superclassExclude - - a superclass to exclude.

requireDefault - - whether or not we will be using writeDefaults().

Method Detail

read

public TField read(int fieldIndex)
            throws FieldAccessException

Reads the value of a field given its index.

Parameters:

fieldIndex - - index of the field.

Returns:

Value of the field.

Throws:

FieldAccessException - The field doesn't exist, or it cannot be accessed under the current security contraints.

readSafely

public TField readSafely(int fieldIndex)
                  throws FieldAccessException

Reads the value of a field if and ONLY IF it exists.

Parameters:

fieldIndex - - index of the field.

Returns:

Value of the field, or NULL if it doesn't exist.

Throws:

FieldAccessException - The field cannot be accessed under the current security contraints.

write

public StructureModifier<TField> write(int fieldIndex,
                              TField value)
                                throws FieldAccessException

Writes the value of a field given its index.

Parameters:

fieldIndex - - index of the field.

value - - new value of the field.

Returns:

This structure modifier - for chaining.

Throws:

FieldAccessException - The field doesn't exist, or it cannot be accessed under the current security contraints.

writeSafely

public StructureModifier<TField> writeSafely(int fieldIndex,
                                    TField value)
                                      throws FieldAccessException

Writes the value of a given field IF and ONLY if it exists.

Parameters:

fieldIndex - - index of the potential field.

value - - new value of the field.

Returns:

This structure modifer - for chaining.

Throws:

FieldAccessException - The field cannot be accessed under the current security contraints.

modify

public StructureModifier<TField> modify(int fieldIndex,
                               com.google.common.base.Function<TField,TField> select)
                                 throws FieldAccessException

Correctly modifies the value of a field.

Parameters:

fieldIndex - - index of the field to modify.

select - - the function that modifies the field value.

Returns:

This structure modifier - for chaining.

Throws:

FieldAccessException - The field cannot be accessed under the current security contraints.

withType

public <T> StructureModifier<T> withType(java.lang.Class fieldType)

Retrieves a structure modifier that only reads and writes fields of a given type.

Parameters:

fieldType - - the type, or supertype, of every field to modify.

Returns:

A structure modifier for fields of this type.

writeDefaults

public StructureModifier<TField> writeDefaults()
                                        throws FieldAccessException

Sets all non-primitive fields to a more fitting default value. See DefaultInstances.getDefault(Class).

Returns:

The current structure modifier - for chaining.

Throws:

FieldAccessException - If we're unable to write to the fields due to a security limitation.

withType

public <T> StructureModifier<T> withType(java.lang.Class fieldType,
                                EquivalentConverter<T> converter)

Retrieves a structure modifier that only reads and writes fields of a given type.

Parameters:

fieldType - - the type, or supertype, of every field to modify.

converter - - converts objects into the given type.

Returns:

A structure modifier for fields of this type.

getFieldType

public java.lang.Class getFieldType()

Retrieves the common type of each field.

Returns:

Common type of each field.

getTargetType

public java.lang.Class getTargetType()

Retrieves the type of the object we're modifying.

Returns:

Type of the object.

getTarget

public java.lang.Object getTarget()

Retrieves the object we're currently modifying.

Returns:

Object we're modifying.

size

public int size()

Retrieve the number of readable types.

Returns:

Readable types.

withTarget

public StructureModifier<TField> withTarget(java.lang.Object target)

Retrieves a structure modifier of the same type for a different object target.

Parameters:

target - - different target of the same type.

Returns:

Structure modifier with the new target.

getFields

public java.util.List<java.lang.reflect.Field> getFields()

Retrieves a list of the fields matching the constraints of this structure modifier.

Returns:

List of fields.

getValues

public java.util.List<TField> getValues()
                                 throws FieldAccessException

Retrieve every value stored in the fields of the current type.

Returns:

Every field value.

Throws:

FieldAccessException - Unable to access one or all of the fields