Package com.comphenix.protocol.reflect.compiler

Class CompiledStructureModifier

java.lang.Object

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

com.comphenix.protocol.reflect.compiler.CompiledStructureModifier

public abstract class CompiledStructureModifier
extends StructureModifier<Object>

Represents a compiled structure modifier.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field	Description
protected StructureCompiler	compiler

Fields inherited from class com.comphenix.protocol.reflect.StructureModifier

converter, customConvertHandling, data, defaultFields, fieldType, subtypeCache, target, targetType, useStructureCompiler

Constructor Summary

Constructors

Constructor	Description
CompiledStructureModifier()

Method Summary

Modifier and Type	Method	Description
Object	read(int fieldIndex)	Reads the value of a field given its index.
protected abstract Object	readGenerated(int fieldIndex)
protected Object	readReflected(int index)	Read the given field index using reflection.
void	setReadOnly(int fieldIndex, boolean value)	Set whether or not a field should be treated as read only.
StructureModifier<Object>	withTarget(Object target)	Retrieves a structure modifier of the same type for a different object target.
StructureModifier<Object>	write(int index, Object value)	Writes the value of a field given its index.
StructureModifier<Object>	writeDefaults()	Sets all non-primitive fields to a more fitting default value.
protected abstract StructureModifier<Object>	writeGenerated(int index, Object value)
protected void	writeReflected(int index, Object value)	Write the given field using reflection.

Methods inherited from class com.comphenix.protocol.reflect.StructureModifier

getField, getFields, getFieldType, getFieldType, getTarget, getTargetType, getValues, initialize, initialize, initialize, isPublic, isReadOnly, modify, optionRead, readSafely, setConverter, setFinalState, size, toString, withFieldType, withFieldType, withParamType, withType, withType, writeSafely

Methods inherited from class java.lang.Object

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

Field Details

compiler

protected StructureCompiler compiler

Constructor Details

CompiledStructureModifier

public CompiledStructureModifier()

Method Details

setReadOnly

public void setReadOnly(int fieldIndex,
 boolean value)
                 throws FieldAccessException

Description copied from class: StructureModifier

Set whether or not a field should be treated as read only.

Note that changing the read-only state to TRUE will only work if the current field was recently read-only or the current structure modifier hasn't been compiled yet.

Overrides:

setReadOnly in class StructureModifier<Object>

Parameters:

fieldIndex - - index of the field.

value - - TRUE if this field should be read only, FALSE otherwise.

Throws:

FieldAccessException - If we cannot modify the read-only status.

writeDefaults

public StructureModifier<Object> writeDefaults()
                                        throws FieldAccessException

Description copied from class: StructureModifier

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

Overrides:

writeDefaults in class StructureModifier<Object>

Returns:

The current structure modifier - for chaining.

Throws:

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

read

public final Object read(int fieldIndex)
                  throws FieldAccessException

Description copied from class: StructureModifier

Reads the value of a field given its index.

Note: This method is prone to exceptions (there are currently 5 total throw statements). It is recommended that you use StructureModifier.readSafely(int), which returns null if the field doesn't exist, instead of throwing an exception.

Overrides:

read in class StructureModifier<Object>

Parameters:

fieldIndex - - index of the field.

Returns:

Value of the field.

Throws:

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

readReflected

protected Object readReflected(int index)
                        throws FieldAccessException

Read the given field index using reflection.

Parameters:

index - - index of field.

Returns:

Resulting value.

Throws:

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

readGenerated

protected abstract Object readGenerated(int fieldIndex)
                                 throws FieldAccessException

Throws:

FieldAccessException

write

public StructureModifier<Object> write(int index,
 Object value)
                                throws FieldAccessException

Description copied from class: StructureModifier

Writes the value of a field given its index.

Overrides:

write in class StructureModifier<Object>

Parameters:

index - - 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.

writeReflected

protected void writeReflected(int index,
 Object value)
                       throws FieldAccessException

Write the given field using reflection.

Parameters:

index - - index of field.

value - - new value.

Throws:

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

writeGenerated

protected abstract StructureModifier<Object> writeGenerated(int index,
 Object value)
                                                     throws FieldAccessException

Throws:

FieldAccessException

withTarget

public StructureModifier<Object> withTarget(Object target)

Description copied from class: StructureModifier

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

Overrides:

withTarget in class StructureModifier<Object>

Parameters:

target - - different target of the same type.

Returns:

Structure modifier with the new target.