lombok.core

Class FieldAugment<T,F>

java.lang.Object

lombok.core.FieldAugment<T,F>

public abstract class FieldAugment<T,F>
extends Object

Method Summary

Modifier and Type	Method and Description
static <T,F> FieldAugment<T,F>	augment(Class<T> type, Class<? super F> fieldType, String name) (Virtually) adds a field to an existing type and returns an object that can be used to read and write this field.
static <T,F> FieldAugment<T,F>	circularSafeAugment(Class<T> type, Class<? super F> fieldType, String name) (Virtually) adds a field to an existing type and returns an object that can be used to read and write this field.
abstract F	clear(T object)
abstract F	compareAndClear(T object, F expected)
abstract F	compareAndSet(T object, F expected, F value)
abstract F	get(T object)
abstract F	getAndSet(T object, F value)
void	set(T object, F value)
abstract F	setIfAbsent(T object, F value)

Methods inherited from class java.lang.Object

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

Method Detail

augment

public static <T,F> FieldAugment<T,F> augment(Class<T> type,
                                              Class<? super F> fieldType,
                                              String name)

(Virtually) adds a field to an existing type and returns an object that can be used to read and write this field.

If the type already declares a non-final instance field with the given name and a compatible field type, that field will be used. Otherwise the field will be provided virtually.

WARNING: The values put into the augment should NOT reference in any way the object you've added the augment to, or memory leaks may occur. If you do need to add such references, use #circularSafeAugment(Class, Class, String, Object) instead.

This code assumes that for any combination of type and name this method is only called once. Otherwise, whether state is shared is undefined.

Parameters:

type - to augment

fieldType - type of the field

name - of the field

defaultValue - the value of the augment if it hasn't been set yet.

Throws:

NullPointerException - if type, fieldType or name is null

circularSafeAugment

public static <T,F> FieldAugment<T,F> circularSafeAugment(Class<T> type,
                                                          Class<? super F> fieldType,
                                                          String name)

(Virtually) adds a field to an existing type and returns an object that can be used to read and write this field.

This method does the same as #augment(Class, Class, String, Object), except it is safe to set values that reference back to their containing object.

get

public abstract F get(T object)

Throws:

NullPointerException - if object is null

set

public final void set(T object,
                      F value)

Throws:

NullPointerException - if object or value is null

getAndSet

public abstract F getAndSet(T object,
                            F value)

Returns:

the value of the field before the operation.

Throws:

NullPointerException - if object or value is null.

clear

public abstract F clear(T object)

Returns:

the value of the field before the operation.

Throws:

NullPointerException - if object is null

compareAndClear

public abstract F compareAndClear(T object,
                                  F expected)

Returns:

the value of the field after the operation. If the value was equal to expected or already cleared null, otherwise the current value.

Throws:

NullPointerException - if object or expected is null

setIfAbsent

public abstract F setIfAbsent(T object,
                              F value)

Returns:

the value of the field after the operation.

Throws:

NullPointerException - if object or value is null

compareAndSet

public abstract F compareAndSet(T object,
                                F expected,
                                F value)

Returns:

the value of the field after the operation.

Throws:

NullPointerException - if object, expected or value is null