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(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 Variable

add, addAnnotation, aget, alength, and, aset, box, boxedType, cast, classType, clear, com, condy, dec, 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_, type, unbox, unboxedType, ushr, xor

Modifier and Type	Method	Description
Variable	add(Object value)	Add this variable with another variable or a constant, and assign the result to a new variable.
default AnnotationMaker	addAnnotation(Object annotationType, boolean visible)	Add an annotation to this variable.
Variable	aget(Object index)	Access an element from this array.
Variable	alength()	Access the length of this array.
Variable	and(Object value)	Compute the bitwise and of this variable with another variable or a constant, and assign the result to a new variable.
void	aset(Object index, Object value)	Set an element into this array.
Variable	box()	Box this primitive variable into its object peer.
Class<?>	boxedType()	Returns a boxed object type for this variable.
Variable	cast(Object type)	Cast this variable to another type, and assign the result to a new variable.
default Class<?>	classType()	Returns the type of this variable, if bound to an existing class.
Variable	clear()	Assign a value of 0, false, or null to this variable, depending on its type.
Variable	com()	Compute the bitwise complement of this variable and assign the result to a new variable.
Bootstrap	condy(String name, Object... args)	Specify a static bootstrap method for dynamically generating constants, as found in the class type of this variable.
void	dec(Object value)	Decrement this variable with another variable or a constant, and assign the result back to this variable.
Variable	div(Object value)	Divide this variable with another variable or a constant, and assign the result to a new variable.
Variable	eq(Object value)	Determine if this variable is equal to another variable or constant, and assign the result to a new boolean variable.
Field	field(String name)	Access a static or instance field from the object referred to by this variable.
Variable	ge(Object value)	Determine if this variable is greater than or equal to another variable or constant, and assign the result to a new boolean variable.
Variable	get()	Return a new variable with the same type and value as this one.
Variable	gt(Object value)	Determine if this variable is greater than another variable or constant, and assign the result to a new boolean variable.
default void	ifEq(Object value, Runnable then)	Convenience method to generate conditional code if this variable is equal to another variable or constant.
default void	ifEq(Object value, Runnable then, Runnable else_)	Convenience method to generate conditional code if this variable is equal to another variable or constant.
void	ifEq(Object value, Label label)	Conditional goto if this variable is equal to another variable or constant.
default void	ifFalse(Runnable then)	Convenience method to generate conditional code if this variable is false.
default void	ifFalse(Runnable then, Runnable else_)	Convenience method to generate conditional code if this variable is false.
void	ifFalse(Label label)	Conditional goto if this variable is false.
default void	ifGe(Object value, Runnable then)	Convenience method to generate conditional code if this variable is greater than or equal to another variable or constant.
default void	ifGe(Object value, Runnable then, Runnable else_)	Convenience method to generate conditional code if this variable is greater than or equal to another variable or constant.
void	ifGe(Object value, Label label)	Conditional goto if this variable is greater than or equal to another variable or constant.
default void	ifGt(Object value, Runnable then)	Convenience method to generate conditional code if this variable is greater than another variable or constant.
default void	ifGt(Object value, Runnable then, Runnable else_)	Convenience method to generate conditional code if this variable is greater than another variable or constant.
void	ifGt(Object value, Label label)	Conditional goto if this variable is greater than another variable or constant.
default void	ifLe(Object value, Runnable then)	Convenience method to generate conditional code if this variable is less than or equal to another variable or constant.
default void	ifLe(Object value, Runnable then, Runnable else_)	Convenience method to generate conditional code if this variable is less than or equal to another variable or constant.
void	ifLe(Object value, Label label)	Conditional goto if this variable is less than or equal to another variable or constant.
default void	ifLt(Object value, Runnable then)	Convenience method to generate conditional code if this variable is less than another variable or constant.
default void	ifLt(Object value, Runnable then, Runnable else_)	Convenience method to generate conditional code if this variable is less than another variable or constant.
void	ifLt(Object value, Label label)	Conditional goto if this variable is less than another variable or constant.
default void	ifNe(Object value, Runnable then)	Convenience method to generate conditional code if this variable is not equal to another variable or constant.
default void	ifNe(Object value, Runnable then, Runnable else_)	Convenience method to generate conditional code if this variable is not equal to another variable or constant.
void	ifNe(Object value, Label label)	Conditional goto if this variable is not equal to another variable or constant.
default void	ifTrue(Runnable then)	Convenience method to generate conditional code if this variable is true.
default void	ifTrue(Runnable then, Runnable else_)	Convenience method to generate conditional code if this variable is true.
void	ifTrue(Label label)	Conditional goto if this variable is true.
void	inc(Object value)	Increment this variable with another variable or a constant, and assign the result back to this variable.
Bootstrap	indy(String name, Object... args)	Specify a static bootstrap method for dynamically generating methods, as found in the class type of this variable.
Variable	instanceOf(Object type)	Determine if this variable is an instance of the given class or interface, and assign the result to a new boolean variable.
Variable	invoke(Object returnType, String name, Object[] types, Object... values)	Invoke a static or instance method on the object referenced by this variable.
Variable	invoke(String name, Object... values)	Invoke a static or instance method on the object referenced by this variable.
Variable	le(Object value)	Determine if this variable is less than or equal to another variable or constant, and assign the result to a new boolean variable.
Variable	lt(Object value)	Determine if this variable is less than another variable or constant, and assign the result to a new boolean variable.
ClassMaker	makerType()	Returns the type of this variable, if bound to a class which is being made.
Variable	methodHandle(Object returnType, String name, Object... types)	Returns a MethodHandle variable which can invoke a static or instance method on the object referenced by this variable.
MethodMaker	methodMaker()	Returns the MethodMaker that this variable belongs to.
void	monitorEnter()	Enter a synchronized block on this variable.
void	monitorExit()	Exit a synchronized block on this variable.
Variable	mul(Object value)	Multiply this variable with another variable or a constant, and assign the result to a new variable.
String	name()	Returns the name of this variable, which is null if it's unnamed.
Variable	ne(Object value)	Determine if this variable is not equal to another variable or constant, and assign the result to a new boolean variable.
Variable	neg()	Negate the value of this variable and assign the result to a new variable.
Variable	not()	Compute the logical negation of this boolean variable, and assign the result to a new variable.
Variable	or(Object value)	Compute the bitwise or of this variable with another variable or a constant, and assign the result to a new variable.
Variable	rem(Object value)	Compute the division remainder of this variable with another variable or a constant, and assign the result to a new variable.
Variable	setExact(Object value)	Assign an exact object instance to this variable, supported only when the class is built dynamically instead of loaded from a file.
Variable	shl(Object value)	Compute the bitwise left shift of this variable with another variable or a constant, and assign the result to a new variable.
Variable	shr(Object value)	Compute the bitwise right shift of this variable with another variable or a constant, and assign the result to a new variable.
Variable	sub(Object value)	Subtract this variable with another variable or a constant, and assign the result to a new variable.
void	switch_(Label defaultLabel, int[] cases, Label... labels)	Generates a switch statement against this int or non-null Integer variable.
void	switch_(Label defaultLabel, Enum<?>[] cases, Label... labels)	Generates a switch statement against this non-null Enum variable.
void	switch_(Label defaultLabel, Object[] cases, Label... labels)	Generates a switch statement against this non-null variable, of any type.
void	switch_(Label defaultLabel, String[] cases, Label... labels)	Generates a switch statement against this non-null String variable.
void	synchronized_(Runnable body)	Convenience method for defining a synchronized block on this variable.
void	throw_()	Throw the exception object referred to by this variable.
Type	type()	Returns the type of this variable.
Variable	unbox()	Unbox this object variable into its primitive peer.
Class<?>	unboxedType()	Returns an unboxed primitive type for this variable.
Variable	ushr(Object value)	Compute the bitwise unsigned right shift of this variable with another variable or a constant, and assign the result to a new variable.
Variable	xor(Object value)	Compute the bitwise xor of this variable with another variable or a constant, and assign the result to a new variable.

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(Object...)

setPlain

void setPlain(Object value)

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

See Also:

• VarHandle.set(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(Object...)

setOpaque

void setOpaque(Object value)

Set the field using opaque mode.

See Also:

• VarHandle.setOpaque(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(Object...)

setRelease

void setRelease(Object value)

Set the field using release mode.

See Also:

• VarHandle.setRelease(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(Object...)

setVolatile

void setVolatile(Object value)

Set the field as if it was declared volatile.

See Also:

• VarHandle.setVolatile(Object...)

compareAndSet

Variable compareAndSet(Object expectedValue,
 Object newValue)

Returns:

the result in a new boolean variable

See Also:

• VarHandle.compareAndSet(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(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(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(Object...)

weakCompareAndSetPlain

Variable weakCompareAndSetPlain(Object expectedValue,
 Object newValue)

Returns:

the result in a new boolean variable

See Also:

• VarHandle.weakCompareAndSetPlain(Object...)

weakCompareAndSet

Variable weakCompareAndSet(Object expectedValue,
 Object newValue)

Returns:

the result in a new boolean variable

See Also:

• VarHandle.weakCompareAndSet(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(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(Object...)

getAndSet

Variable getAndSet(Object value)

Returns:

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

See Also:

• VarHandle.getAndSet(Object...)

getAndSetAcquire

Variable getAndSetAcquire(Object value)

Returns:

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

See Also:

• VarHandle.getAndSetAcquire(Object...)

getAndSetRelease

Variable getAndSetRelease(Object value)

Returns:

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

See Also:

• VarHandle.getAndSetRelease(Object...)

getAndAdd

Variable getAndAdd(Object value)

Returns:

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

See Also:

• VarHandle.getAndAdd(Object...)

getAndAddAcquire

Variable getAndAddAcquire(Object value)

Returns:

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

See Also:

• VarHandle.getAndAddAcquire(Object...)

getAndAddRelease

Variable getAndAddRelease(Object value)

Returns:

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

See Also:

• VarHandle.getAndAddRelease(Object...)

getAndBitwiseOr

Variable getAndBitwiseOr(Object value)

Returns:

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

See Also:

• VarHandle.getAndBitwiseOr(Object...)

getAndBitwiseOrAcquire

Variable getAndBitwiseOrAcquire(Object value)

Returns:

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

See Also:

• VarHandle.getAndBitwiseOrAcquire(Object...)

getAndBitwiseOrRelease

Variable getAndBitwiseOrRelease(Object value)

Returns:

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

See Also:

• VarHandle.getAndBitwiseOrRelease(Object...)

getAndBitwiseAnd

Variable getAndBitwiseAnd(Object value)

Returns:

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

See Also:

• VarHandle.getAndBitwiseAnd(Object...)

getAndBitwiseAndAcquire

Variable getAndBitwiseAndAcquire(Object value)

Returns:

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

See Also:

• VarHandle.getAndBitwiseAndAcquire(Object...)

getAndBitwiseAndRelease

Variable getAndBitwiseAndRelease(Object value)

Returns:

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

See Also:

• VarHandle.getAndBitwiseAndRelease(Object...)

getAndBitwiseXor

Variable getAndBitwiseXor(Object value)

Returns:

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

See Also:

• VarHandle.getAndBitwiseXor(Object...)

getAndBitwiseXorAcquire

Variable getAndBitwiseXorAcquire(Object value)

Returns:

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

See Also:

• VarHandle.getAndBitwiseXorAcquire(Object...)

getAndBitwiseXorRelease

Variable getAndBitwiseXorRelease(Object value)

Returns:

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

See Also:

• VarHandle.getAndBitwiseXorRelease(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.