net.tridentsdk.docs

Annotation Type Policy

@Documented
public @interface Policy

Use to document usage of esoteric or difficult/subtle to understand portions of code

Author:

The TridentSDK Team

Field Summary

Fields

Modifier and Type	Fields and Description
static String	VOLATILE_ARRAY Denotes a volatile array whose elements should not be mutated singularly

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The policy of which to abide by when using the particular member

Field Detail

VOLATILE_ARRAY

public static final String VOLATILE_ARRAY

Denotes a volatile array whose elements should not be mutated singularly

Possible solutions include:

• Use an AtomicReferenceArray instead
• Modify the array as a whole instead of the single element
• Contact the concurrency supervisor

Justification: Volatile arrays entail a volatile reference to the whole memory block; not each individual element. Mutations of a point along the block is a violation of object consistency

Element Detail

value

public abstract String value

The policy of which to abide by when using the particular member

Returns:

the policy