Module org.cojen.maker

Package org.cojen.maker

Interface Field

All Superinterfaces:

Variable

public interface Field
extends Variable

Represents a field accessible by the body of a method. Note that the most commonly used features are inherited from the Variable interface.

See Also:

• MethodMaker.field(java.lang.String)

Method Summary

Modifier and Type	Method	Description
Variable	compareAndExchange(Object expectedValue, Object newValue)
Variable	compareAndExchangeAcquire(Object expectedValue, Object newValue)
Variable	compareAndExchangeRelease(Object expectedValue, Object newValue)
Variable	compareAndSet(Object expectedValue, Object newValue)
Variable	getAcquire()	Access the field using acquire mode.
Variable	getAndAdd(Object value)
Variable	getAndAddAcquire(Object value)
Variable	getAndAddRelease(Object value)
Variable	getAndBitwiseAnd(Object value)
Variable	getAndBitwiseAndAcquire(Object value)
Variable	getAndBitwiseAndRelease(Object value)
Variable	getAndBitwiseOr(Object value)
Variable	getAndBitwiseOrAcquire(Object value)
Variable	getAndBitwiseOrRelease(Object value)
Variable	getAndBitwiseXor(Object value)
Variable	getAndBitwiseXorAcquire(Object value)
Variable	getAndBitwiseXorRelease(Object value)
Variable	getAndSet(Object value)
Variable	getAndSetAcquire(Object value)
Variable	getAndSetRelease(Object value)
Variable	getOpaque()	Access the field using opaque mode.
Variable	getPlain()	Access the field using plain mode, ignoring any volatile declaration.
Variable	getVolatile()	Access the field as if it was declared volatile.
Variable	methodHandleGet()	Returns a MethodHandle variable for getting the field value.
Variable	methodHandleSet()	Returns a MethodHandle variable for setting the field value.
default Field	name(String name)	Fields cannot be renamed, and so this method always throws an IllegalStateException.
Field	set(Object value)	Assign a value to this variable, either from another variable or from a constant.
void	setOpaque(Object value)	Set the field using opaque mode.
void	setPlain(Object value)	Set the field using plain mode, ignoring any volatile declaration.
void	setRelease(Object value)	Set the field using release mode.
void	setVolatile(Object value)	Set the field as if it was declared volatile.
default Field	signature(Object... components)	Fields cannot have a signature defined within the body of a method, and so this method always throws an IllegalStateException.
Variable	varHandle()	Returns a VarHandle variable which accesses the field.
Variable	weakCompareAndSet(Object expectedValue, Object newValue)
Variable	weakCompareAndSetAcquire(Object expectedValue, Object newValue)
Variable	weakCompareAndSetPlain(Object expectedValue, Object newValue)
Variable	weakCompareAndSetRelease(Object expectedValue, Object newValue)

Methods inherited from interface org.cojen.maker.Variable

add, addAnnotation, aget, alength, and, aset, box, boxedType, cast, classType, clear, com, condy, div, eq, field, ge, get, gt, ifEq, ifEq, ifEq, ifFalse, ifFalse, ifFalse, ifGe, ifGe, ifGe, ifGt, ifGt, ifGt, ifLe, ifLe, ifLe, ifLt, ifLt, ifLt, ifNe, ifNe, ifNe, ifTrue, ifTrue, ifTrue, inc, indy, instanceOf, invoke, invoke, le, lt, makerType, methodHandle, methodMaker, monitorEnter, monitorExit, mul, name, ne, neg, not, or, rem, setExact, shl, shr, sub, switch_, switch_, switch_, switch_, synchronized_, throw_, unbox, unboxedType, ushr, xor

Method Details

name

default Field name(String name)

Fields cannot be renamed, and so this method always throws an IllegalStateException.

Specified by:

name in interface Variable

Returns:

this variable

signature

default Field signature(Object... components)

Fields cannot have a signature defined within the body of a method, and so this method always throws an IllegalStateException.

Specified by:

signature in interface Variable

Returns:

this

set

Field set(Object value)

Assign a value to this variable, either from another variable or from a constant. A constant value can be a primitive type (boxed or unboxed), null, a String, a Class, an Enum, a MethodType, a MethodHandleInfo, a ConstantDesc, or a Constable.

Note that a MethodHandle can be set with a MethodHandleInfo, which is converted automatically at link time. Handling of ConstantDesc and Constable is also treated specially — the actual type is determined by the resolved constant.

Specified by:

set in interface Variable

Parameters:

value - a Variable or a constant

Returns:

this variable

getPlain

Variable getPlain()

Access the field using plain mode, ignoring any volatile declaration.

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.get(java.lang.Object...)

setPlain

void setPlain(Object value)

Set the field using plain mode, ignoring any volatile declaration.

See Also:

• VarHandle.set(java.lang.Object...)

getOpaque

Variable getOpaque()

Access the field using opaque mode.

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getOpaque(java.lang.Object...)

setOpaque

void setOpaque(Object value)

Set the field using opaque mode.

See Also:

• VarHandle.setOpaque(java.lang.Object...)

getAcquire

Variable getAcquire()

Access the field using acquire mode.

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getAcquire(java.lang.Object...)

setRelease

void setRelease(Object value)

Set the field using release mode.

See Also:

• VarHandle.setRelease(java.lang.Object...)

getVolatile

Variable getVolatile()

Access the field as if it was declared volatile.

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getVolatile(java.lang.Object...)

setVolatile

void setVolatile(Object value)

Set the field as if it was declared volatile.

See Also:

• VarHandle.setVolatile(java.lang.Object...)

compareAndSet

Variable compareAndSet(Object expectedValue,
 Object newValue)

Returns:

the result in a new boolean variable

See Also:

• VarHandle.compareAndSet(java.lang.Object...)

compareAndExchange

Variable compareAndExchange(Object expectedValue,
 Object newValue)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.compareAndExchange(java.lang.Object...)

compareAndExchangeAcquire

Variable compareAndExchangeAcquire(Object expectedValue,
 Object newValue)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.compareAndExchangeAcquire(java.lang.Object...)

compareAndExchangeRelease

Variable compareAndExchangeRelease(Object expectedValue,
 Object newValue)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.compareAndExchangeRelease(java.lang.Object...)

weakCompareAndSetPlain

Variable weakCompareAndSetPlain(Object expectedValue,
 Object newValue)

Returns:

the result in a new boolean variable

See Also:

• VarHandle.weakCompareAndSetPlain(java.lang.Object...)

weakCompareAndSet

Variable weakCompareAndSet(Object expectedValue,
 Object newValue)

Returns:

the result in a new boolean variable

See Also:

• VarHandle.weakCompareAndSet(java.lang.Object...)

weakCompareAndSetAcquire

Variable weakCompareAndSetAcquire(Object expectedValue,
 Object newValue)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.weakCompareAndSetAcquire(java.lang.Object...)

weakCompareAndSetRelease

Variable weakCompareAndSetRelease(Object expectedValue,
 Object newValue)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.weakCompareAndSetRelease(java.lang.Object...)

getAndSet

Variable getAndSet(Object value)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getAndSet(java.lang.Object...)

getAndSetAcquire

Variable getAndSetAcquire(Object value)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getAndSetAcquire(java.lang.Object...)

getAndSetRelease

Variable getAndSetRelease(Object value)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getAndSetRelease(java.lang.Object...)

getAndAdd

Variable getAndAdd(Object value)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getAndAdd(java.lang.Object...)

getAndAddAcquire

Variable getAndAddAcquire(Object value)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getAndAddAcquire(java.lang.Object...)

getAndAddRelease

Variable getAndAddRelease(Object value)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getAndAddRelease(java.lang.Object...)

getAndBitwiseOr

Variable getAndBitwiseOr(Object value)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getAndBitwiseOr(java.lang.Object...)

getAndBitwiseOrAcquire

Variable getAndBitwiseOrAcquire(Object value)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getAndBitwiseOrAcquire(java.lang.Object...)

getAndBitwiseOrRelease

Variable getAndBitwiseOrRelease(Object value)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getAndBitwiseOrRelease(java.lang.Object...)

getAndBitwiseAnd

Variable getAndBitwiseAnd(Object value)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getAndBitwiseAnd(java.lang.Object...)

getAndBitwiseAndAcquire

Variable getAndBitwiseAndAcquire(Object value)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getAndBitwiseAndAcquire(java.lang.Object...)

getAndBitwiseAndRelease

Variable getAndBitwiseAndRelease(Object value)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getAndBitwiseAndRelease(java.lang.Object...)

getAndBitwiseXor

Variable getAndBitwiseXor(Object value)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getAndBitwiseXor(java.lang.Object...)

getAndBitwiseXorAcquire

Variable getAndBitwiseXorAcquire(Object value)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getAndBitwiseXorAcquire(java.lang.Object...)

getAndBitwiseXorRelease

Variable getAndBitwiseXorRelease(Object value)

Returns:

the result in a new variable, with the same type as this one

See Also:

• VarHandle.getAndBitwiseXorRelease(java.lang.Object...)

varHandle

Variable varHandle()

Returns a VarHandle variable which accesses the field. If this is an ordinary field, the variable is actually a constant, and so it can be supplied as an argument to a bootstrap method or be used by another method in the same class. For non-static fields, the first VarHandle coordinate is the object instance which owns the field. Static fields have no coordinates.

methodHandleSet

Variable methodHandleSet()

Returns a MethodHandle variable for setting the field value. If this is an ordinary field, the variable is actually a constant, and so it can be supplied as an argument to a bootstrap method or be used by another method in the same class. For non-static fields, the MethodHandle accepts two arguments: the object instance which owns the field, and the value to set. For static fields, the only argument is the value to set.

methodHandleGet

Variable methodHandleGet()

Returns a MethodHandle variable for getting the field value. If this is an ordinary field, the variable is actually a constant, and so it can be supplied as an argument to a bootstrap method or be used by another method in the same class. For non-static fields, the MethodHandle accepts one argument: the object instance which owns the field. For static fields, there are no arguments.