org.immutables.value

Annotation Type Value.Style

@Target(value={TYPE,PACKAGE,ANNOTATION_TYPE})
public static @interface Value.Style

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	add
String	addAll
String	addAllBuilder
String	addBuilder
Class<? extends Annotation>[]	additionalJsonAnnotations
boolean	allMandatoryParameters
Class<? extends Annotation>[]	allowedClasspathAnnotations
boolean	allParameters
boolean	alwaysPublicInitializers
String[]	attributeBuilder
boolean	attributeBuilderDetection
boolean	attributelessSingleton
boolean	beanFriendlyModifiables
String	build
String	builder
Value.Style.BuilderVisibility	builderVisibility
String	buildOrThrow
boolean	builtinContainerAttributes
String	canBuild
String	clear
boolean	clearBuilder
String	copyOf
String	create
boolean	deepImmutablesDetection
boolean	defaultAsDefault
Value.Immutable	defaults
boolean	deferCollectionAllocation
boolean	depluralize
String[]	depluralizeDictionary
boolean	forceJacksonIgnoreFields
boolean	forceJacksonPropertyNames
String	from
boolean	generateSuppressAllWarnings
String[]	get
String	getBuilder
String	getBuilders
boolean	headerComments
Class<?>[]	immutableCopyOfRoutines
boolean	implementationNestedInBuilder
String	init
String	instance
String	isInitialized
String	isSet
boolean	jacksonIntegration
boolean	jdkOnly
String	newBuilder
String	nullableAnnotation
String	of
boolean	optionalAcceptNullable
boolean	overshadowImplementation
String	packageGenerated
Class<? extends Annotation>[]	passAnnotations
boolean	privateNoargConstructor
String	put
String	putAll
String	redactedMask
String	set
String	setBuilder
boolean	stagedBuilder
boolean	strictBuilder
Class<? extends RuntimeException>	throwForInvalidImmutableState
Class<? extends RuntimeException>	throwForNullPointer
String	toImmutable
String[]	typeAbstract
String	typeBuilder
String	typeImmutable
String	typeImmutableEnclosing
String	typeImmutableNested
String	typeInnerBuilder
String	typeModifiable
String	typeWith
boolean	unsafeDefaultAndDerived
String	unset
Value.Style.ValidationMethod	validationMethod
Value.Style.ImplementationVisibility	visibility
boolean	weakInterning
String	with

Element Detail

get

public abstract String[] get

Default:

"get*"

init

public abstract String init

Default:

"*"

with

public abstract String with

Default:

"with*"

add

public abstract String add

Default:

"add*"

addAll

public abstract String addAll

Default:

"addAll*"

put

public abstract String put

Default:

"put*"

putAll

public abstract String putAll

Default:

"putAll*"

copyOf

public abstract String copyOf

Default:

"copyOf"

of

public abstract String of

Default:

"of"

instance

public abstract String instance

Default:

"of"

builder

public abstract String builder

Default:

"builder"

newBuilder

public abstract String newBuilder

Default:

"new"

from

public abstract String from

Default:

"from"

build

public abstract String build

Default:

"build"

buildOrThrow

public abstract String buildOrThrow

Default:

""

canBuild

public abstract String canBuild

Default:

""

isInitialized

public abstract String isInitialized

Default:

"isInitialized"

isSet

public abstract String isSet

Default:

"*IsSet"

set

public abstract String set

Default:

"set*"

unset

public abstract String unset

Default:

"unset*"

clear

public abstract String clear

Default:

"clear"

create

public abstract String create

Default:

"create"

toImmutable

public abstract String toImmutable

Default:

"toImmutable"

typeBuilder

public abstract String typeBuilder

Default:

"Builder"

typeInnerBuilder

public abstract String typeInnerBuilder

Default:

"Builder"

typeAbstract

public abstract String[] typeAbstract

Default:

"Abstract*"

typeImmutable

public abstract String typeImmutable

Default:

"Immutable*"

typeImmutableEnclosing

public abstract String typeImmutableEnclosing

Default:

"Immutable*"

typeImmutableNested

public abstract String typeImmutableNested

Default:

"*"

typeModifiable

public abstract String typeModifiable

Default:

"Modifiable*"

typeWith

public abstract String typeWith

Default:

"With*"

packageGenerated

public abstract String packageGenerated

Default:

"*"

defaults

public abstract Value.Immutable defaults

Default:

@org.immutables.value.Value.Immutable

jdkOnly

public abstract boolean jdkOnly

Default:

false

strictBuilder

public abstract boolean strictBuilder

Default:

false

validationMethod

public abstract Value.Style.ValidationMethod validationMethod

Default:

org.immutables.value.Value.Style.ValidationMethod.SIMPLE

allParameters

public abstract boolean allParameters

Default:

false

defaultAsDefault

public abstract boolean defaultAsDefault

Default:

false

headerComments

public abstract boolean headerComments

Default:

false

passAnnotations

public abstract Class<? extends Annotation>[] passAnnotations

Default:

{}

additionalJsonAnnotations

public abstract Class<? extends Annotation>[] additionalJsonAnnotations

Default:

{}

visibility

public abstract Value.Style.ImplementationVisibility visibility

Default:

org.immutables.value.Value.Style.ImplementationVisibility.SAME

optionalAcceptNullable

public abstract boolean optionalAcceptNullable

Default:

false

generateSuppressAllWarnings

public abstract boolean generateSuppressAllWarnings

Default:

true

privateNoargConstructor

public abstract boolean privateNoargConstructor

Default:

false

attributelessSingleton

public abstract boolean attributelessSingleton

Default:

false

unsafeDefaultAndDerived

public abstract boolean unsafeDefaultAndDerived

Default:

false

clearBuilder

public abstract boolean clearBuilder

Default:

false

deferCollectionAllocation

public abstract boolean deferCollectionAllocation

Default:

false

deepImmutablesDetection

public abstract boolean deepImmutablesDetection

Default:

false

overshadowImplementation

public abstract boolean overshadowImplementation

Default:

false

implementationNestedInBuilder

public abstract boolean implementationNestedInBuilder

Default:

false

forceJacksonPropertyNames

public abstract boolean forceJacksonPropertyNames

Default:

true

forceJacksonIgnoreFields

public abstract boolean forceJacksonIgnoreFields

Default:

false

jacksonIntegration

public abstract boolean jacksonIntegration

Default:

true

weakInterning

public abstract boolean weakInterning

Default:

false

alwaysPublicInitializers

public abstract boolean alwaysPublicInitializers

Default:

true

builderVisibility

public abstract Value.Style.BuilderVisibility builderVisibility

Default:

org.immutables.value.Value.Style.BuilderVisibility.PUBLIC

throwForInvalidImmutableState

public abstract Class<? extends RuntimeException> throwForInvalidImmutableState

Default:

java.lang.IllegalStateException.class

throwForNullPointer

public abstract Class<? extends RuntimeException> throwForNullPointer

Default:

java.lang.NullPointerException.class

depluralize

public abstract boolean depluralize

Default:

false

depluralizeDictionary

public abstract String[] depluralizeDictionary

Default:

{}

immutableCopyOfRoutines

public abstract Class<?>[] immutableCopyOfRoutines

Default:

{}

stagedBuilder

public abstract boolean stagedBuilder

Default:

false

builtinContainerAttributes

public abstract boolean builtinContainerAttributes

Default:

true

beanFriendlyModifiables

public abstract boolean beanFriendlyModifiables

Default:

false

allMandatoryParameters

public abstract boolean allMandatoryParameters

Default:

false

redactedMask

public abstract String redactedMask

Default:

""

nullableAnnotation

public abstract String nullableAnnotation

Default:

"Nullable"

attributeBuilderDetection

public abstract boolean attributeBuilderDetection

Default:

false

attributeBuilder

public abstract String[] attributeBuilder

Default:

{"*Builder", "builder", "new"}

getBuilder

public abstract String getBuilder

Default:

"*Builder"

setBuilder

public abstract String setBuilder

Default:

"*Builder"

addBuilder

public abstract String addBuilder

Default:

"add*Builder"

addAllBuilder

public abstract String addAllBuilder

Default:

"addAll*Builders"

getBuilders

public abstract String getBuilders

Default:

"*Builders"

allowedClasspathAnnotations

public abstract Class<? extends Annotation>[] allowedClasspathAnnotations

Default:

{}