Package org.immutables.value

Annotation Type Value

public @interface Value

This annotation provides namespace for annotations for immutable value object generation. Use one of the nested annotation.

See Also:

• Value.Immutable
• Value.Include
• Value.Enclosing

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	Value.Auxiliary	Annotate attribute as auxiliary and it will be stored and will be accessible, but will be excluded from generated equals, hashCode and toString methods.
static @interface	Value.Check	Annotates method that should be invoked internally to validate invariants after instance had been created, but before returned to a client.
static @interface	Value.Default	Annotates accessor that should be turned in set-able generated attribute.
static @interface	Value.Derived	This kind of attribute cannot be set during building, but they are eagerly computed from other attributes and stored in field.
static @interface	Value.Enclosing	This annotation could be applied to top level class which contains nested abstract value types to provide namespacing for the generated implementation classes.
static @interface	Value.Immutable	Instruct processor to generate immutable implementation of abstract value type.
static @interface	Value.Include	Includes specified abstract value types into generation of processing.
static @interface	Value.Lazy	Lazy attributes cannot be set, defined as method that computes value, which is invoke lazily once and only once in a thread safe manner.
static @interface	Value.Modifiable	Generate modifiable implementation of abstract value class.
static @interface	Value.NaturalOrder	Specified natural ordering for the implemented SortedSet, NavigableSet or SortedMap, NavigableMap.
static @interface	Value.NonAttribute	Can be used to mark some abstract no-argument methods in supertypes (about to be implemented/extended by abstract value types) as regular, non-attribute methods, i.e.
static @interface	Value.Parameter	Works with Value.Immutable classes to mark abstract accessor method be included as "of(..)" constructor parameter.
static @interface	Value.Redacted	Marks attribute for exclusion from auto-generated toString method.
static @interface	Value.ReverseOrder	Specified reversed natural ordering for the implemented SortedSet, NavigableSet or SortedMap, NavigableMap.
static @interface	Value.Style	Naming and structural style could be used to customize convention of the generated immutable implementations and companion classes.