com.comphenix.protocol.reflect

Class VolatileField

java.lang.Object

com.comphenix.protocol.reflect.VolatileField

public class VolatileField
extends java.lang.Object

Represents a field that will revert to its original state when this class is garbaged collected.

Author:

Kristian

Constructor Summary

Constructors

Constructor and Description
VolatileField(FieldAccessor accessor, java.lang.Object container) Initializes a volatile field with the given accessor and associated object.
VolatileField(java.lang.reflect.Field field, java.lang.Object container) Initializes a volatile field with an associated object.
VolatileField(java.lang.reflect.Field field, java.lang.Object container, boolean forceAccess) Initializes a volatile field with an associated object.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	finalize()
java.lang.Object	getContainer() Retrieves the object the field is stored.
java.lang.reflect.Field	getField() Retrieves the current field.
java.lang.Object	getOldValue() Retrieves the field value before the previous setValue(), unless saveValue() has been called.
java.lang.Object	getValue() Retrieves the current field value.
boolean	isCurrentSet() Determine whether or not we'll need to revert the value.
boolean	isForceAccess() Retrieves whether or not not to override any scope restrictions.
void	refreshValue() Reapply the current changed value.
void	revertValue() Revert to the previously set value.
void	saveValue() Ensure that the current value is still set after this class has been garbaged collected.
void	setForceAccess(boolean forceAccess) Sets whether or not not to override any scope restrictions.
void	setValue(java.lang.Object newValue) Sets the current value.
java.lang.String	toString()
VolatileField	toSynchronized() Retrieve a synchronized version of the current field.

Methods inherited from class java.lang.Object

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

Constructor Detail

VolatileField

public VolatileField(java.lang.reflect.Field field,
             java.lang.Object container)

Initializes a volatile field with an associated object.

Parameters:

field - - the field.

container - - the object this field belongs to.

VolatileField

public VolatileField(java.lang.reflect.Field field,
             java.lang.Object container,
             boolean forceAccess)

Initializes a volatile field with an associated object.

Parameters:

field - - the field.

container - - the object this field belongs to.

forceAccess - - whether or not to override any scope restrictions.

VolatileField

public VolatileField(FieldAccessor accessor,
             java.lang.Object container)

Initializes a volatile field with the given accessor and associated object.

Parameters:

accessor - - the field accessor.

container - - the object this field belongs to.

Method Detail

getField

public java.lang.reflect.Field getField()

Retrieves the current field.

Returns:

The stored field.

getContainer

public java.lang.Object getContainer()

Retrieves the object the field is stored.

Returns:

The reference object.

isForceAccess

public boolean isForceAccess()

Retrieves whether or not not to override any scope restrictions.

Returns:

TRUE if we override scope, FALSE otherwise.

setForceAccess

public void setForceAccess(boolean forceAccess)

Sets whether or not not to override any scope restrictions.

Parameters:

forceAccess - - TRUE if we override scope, FALSE otherwise.

getValue

public java.lang.Object getValue()

Retrieves the current field value.

Returns:

The current field value.

getOldValue

public java.lang.Object getOldValue()

Retrieves the field value before the previous setValue(), unless saveValue() has been called.

Returns:

Previous value.

setValue

public void setValue(java.lang.Object newValue)

Sets the current value. This will be reverted unless saveValue() is called.

Parameters:

newValue - - new field value.

refreshValue

public void refreshValue()

Reapply the current changed value.

Also refresh the previously set value.

saveValue

public void saveValue()

Ensure that the current value is still set after this class has been garbaged collected.

revertValue

public void revertValue()

Revert to the previously set value.

toSynchronized

public VolatileField toSynchronized()

Retrieve a synchronized version of the current field.

Returns:

A synchronized volatile field.

isCurrentSet

public boolean isCurrentSet()

Determine whether or not we'll need to revert the value.

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object