Class StyleMirror
java.lang.Object
org.immutables.value.processor.meta.StyleMirror
- All Implemented Interfaces:
Annotation
StyleMirror used to parse data of AnnotationMirror for original annotation
org.immutables.value.Value.Style
during annotation processing. Interface is being described using ValueMirrors.Style annotation,
which should be structurally compatible to the annotation being modelled.- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classprivate static classNested classes/interfaces inherited from class org.immutables.value.processor.meta.ValueMirrors.Style
ValueMirrors.Style.BuilderVisibility, ValueMirrors.Style.ImplementationVisibility, ValueMirrors.Style.ValidationMethod -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Stringprivate final Stringprivate final Stringprivate final Stringprivate final TypeMirror[]private final String[]private final booleanprivate final TypeMirror[]private final String[]private final booleanprivate final booleanprivate final AnnotationMirrorprivate final String[]private final booleanprivate final booleanprivate final booleanprivate final Stringprivate final Stringprivate final ValueMirrors.Style.BuilderVisibilityprivate final Stringprivate final Stringprivate final booleanprivate final Stringprivate final Stringprivate final booleanprivate final Stringprivate final Stringprivate final booleanprivate final booleanprivate final AnnotationMirrorprivate final ImmutableMirrorprivate final booleanprivate final Stringprivate final booleanprivate final String[]private final TypeMirrorprivate final Stringprivate final booleanprivate final booleanprivate final booleanprivate final booleanprivate final Stringprivate final booleanprivate final String[]private final Stringprivate final Stringprivate final booleanprivate final TypeMirror[]private final String[]private final booleanprivate final Stringprivate final Stringprivate final Stringprivate final Stringprivate final Stringprivate final booleanprivate final booleanprivate final booleanprivate final booleanprivate final intstatic final Stringprivate final Stringprivate final Stringprivate final Stringprivate final booleanprivate final booleanprivate final Stringprivate final TypeMirror[]private final String[]private final booleanprivate final booleanprivate final Stringprivate final Stringstatic final Stringprivate final Stringprivate final Stringprivate final Stringprivate final booleanprivate final booleanprivate final booleanprivate final TypeMirrorprivate final Stringprivate final TypeMirrorprivate final Stringprivate final Stringprivate final Stringprivate final booleanprivate final String[]private final Stringprivate final Stringprivate final Stringprivate final Stringprivate final Stringprivate final Stringprivate final Stringprivate final Stringprivate final Stringprivate final Stringprivate final Stringprivate final booleanprivate final Stringprivate final ValueMirrors.Style.ValidationMethodprivate final ValueMirrors.Style.ImplementationVisibilityprivate final Stringprivate final booleanprivate final Stringprivate final String -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateStyleMirror(AnnotationMirror annotationMirror) privateStyleMirror(TypeElement defaultAnnotationElement) -
Method Summary
Modifier and TypeMethodDescriptionadd()addAll()Class<? extends Annotation>[]Deprecated.Always throws UnsupportedOperationException.String[]booleanClass<? extends Annotation>[]Deprecated.Always throws UnsupportedOperationException.String[]booleanbooleanClass<? extends Annotation> String[]booleanbooleanbooleanbuild()builder()booleancanBuild()clear()booleancopyOf()create()booleanbooleandefaults()booleanbooleanString[]booleanClass<? extends Annotation> Deprecated.Always throws UnsupportedOperationException.booleanstatic com.google.common.base.Optional<StyleMirror> find(Iterable<? extends AnnotationMirror> mirrors) Finds first annotation of this type in an iterable of annotation mirrors.static com.google.common.base.Optional<StyleMirror> Finds first annotation of this type on the element.booleanbooleanbooleanfrom()static com.google.common.base.Optional<StyleMirror> from(AnnotationMirror mirror) Tries to convert annotation mirror to this annotation type.static StyleMirrorfrom(TypeElement element) Creates mirror with default values using annotation element (i.e.static com.google.common.collect.ImmutableList<StyleMirror> fromAll(Iterable<? extends AnnotationMirror> mirrors) Converts iterable of annotation mirrors where all annotation are of this type.booleanString[]get()inthashCode()booleanClass<?>[]Deprecated.Always throws UnsupportedOperationException.String[]booleaninit()instance()static booleanisSet()booleanbooleanjakarta()booleanbooleanjdkOnly()intstatic Stringof()booleanbooleanClass<? extends Annotation>[]Deprecated.Always throws UnsupportedOperationException.String[]booleanbooleanput()putAll()static Stringset()static StringbooleanbooleanbooleanDeprecated.Always throws UnsupportedOperationException.Deprecated.Always throws UnsupportedOperationException.toString()booleanString[]typeWith()booleanunset()booleanwith()
-
Field Details
-
QUALIFIED_NAME
- See Also:
-
MIRROR_QUALIFIED_NAME
- See Also:
-
annotationMirror
-
get
-
init
-
with
-
withUnaryOperator
-
add
-
addAll
-
put
-
putAll
-
copyOf
-
of
-
instance
-
builder
-
newBuilder
-
from
-
build
-
buildOrThrow
-
canBuild
-
toBuilder
-
underrideHashCode
-
underrideEquals
-
underrideToString
-
delegateToString
-
includeHashCode
-
isInitialized
-
isSet
-
set
-
unset
-
clear
-
create
-
toImmutable
-
typeBuilder
-
typeInnerBuilder
-
typeAbstract
-
typeImmutable
-
typeImmutableEnclosing
-
typeImmutableNested
-
typeModifiable
-
typeInnerModifiable
-
typeWith
-
packageGenerated
-
defaults
-
defaultsMirror
-
strictBuilder
private final boolean strictBuilder -
strictModifiable
private final boolean strictModifiable -
validationMethod
-
allParameters
private final boolean allParameters -
defaultAsDefault
private final boolean defaultAsDefault -
headerComments
private final boolean headerComments -
jdkOnly
private final boolean jdkOnly -
jdk9Collections
private final boolean jdk9Collections -
passAnnotations
-
passAnnotationsName
-
additionalJsonAnnotations
-
additionalJsonAnnotationsName
-
visibility
-
visibilityString
-
optionalAcceptNullable
private final boolean optionalAcceptNullable -
generateSuppressAllWarnings
private final boolean generateSuppressAllWarnings -
privateNoargConstructor
private final boolean privateNoargConstructor -
protectedNoargConstructor
private final boolean protectedNoargConstructor -
attributelessSingleton
private final boolean attributelessSingleton -
unsafeDefaultAndDerived
private final boolean unsafeDefaultAndDerived -
clearBuilder
private final boolean clearBuilder -
deferCollectionAllocation
private final boolean deferCollectionAllocation -
deepImmutablesDetection
private final boolean deepImmutablesDetection -
overshadowImplementation
private final boolean overshadowImplementation -
implementationNestedInBuilder
private final boolean implementationNestedInBuilder -
forceJacksonPropertyNames
private final boolean forceJacksonPropertyNames -
forceJacksonIgnoreFields
private final boolean forceJacksonIgnoreFields -
forceEqualsInWithers
private final boolean forceEqualsInWithers -
jacksonIntegration
private final boolean jacksonIntegration -
weakInterning
private final boolean weakInterning -
alwaysPublicInitializers
private final boolean alwaysPublicInitializers -
builderVisibility
-
builderVisibilityString
-
throwForInvalidImmutableState
-
throwForInvalidImmutableStateName
-
throwForNullPointer
-
throwForNullPointerName
-
depluralize
private final boolean depluralize -
depluralizeDictionary
-
immutableCopyOfRoutines
-
immutableCopyOfRoutinesName
-
stagedBuilder
private final boolean stagedBuilder -
builtinContainerAttributes
private final boolean builtinContainerAttributes -
beanFriendlyModifiables
private final boolean beanFriendlyModifiables -
allMandatoryParameters
private final boolean allMandatoryParameters -
redactedMask
-
attributeBuilderDetection
private final boolean attributeBuilderDetection -
transientDerivedFields
private final boolean transientDerivedFields -
finalInstanceFields
private final boolean finalInstanceFields -
attributeBuilder
-
getBuilder
-
setBuilder
-
addBuilder
-
addAllBuilder
-
getBuilders
-
nullableAnnotation
-
limitStringLengthInToString
private final int limitStringLengthInToString -
allowedClasspathAnnotations
-
allowedClasspathAnnotationsName
-
fallbackNullableAnnotation
-
fallbackNullableAnnotationName
-
jakarta
private final boolean jakarta
-
-
Constructor Details
-
StyleMirror
-
StyleMirror
-
-
Method Details
-
mirrorQualifiedName
-
qualifiedName
-
simpleName
-
isPresent
-
find
Finds first annotation of this type on the element.- Parameters:
element- annotated element- Returns:
- optional
StyleMirror, present if this annotation found
-
find
public static com.google.common.base.Optional<StyleMirror> find(Iterable<? extends AnnotationMirror> mirrors) Finds first annotation of this type in an iterable of annotation mirrors.- Parameters:
mirrors- annotation mirrors- Returns:
- optional
StyleMirror, present if this annotation found
-
fromAll
public static com.google.common.collect.ImmutableList<StyleMirror> fromAll(Iterable<? extends AnnotationMirror> mirrors) Converts iterable of annotation mirrors where all annotation are of this type. Otherwise it fails- Parameters:
mirrors- of this annotation type.- Returns:
- list of converted
StyleMirrors
-
from
Creates mirror with default values using annotation element (i.e. declaration, not usage).- Parameters:
element- annotation type element- Returns:
StyleMirror
-
from
Tries to convert annotation mirror to this annotation type.- Parameters:
mirror- annotation mirror- Returns:
- optional
StyleMirror, present if mirror matched this annotation type
-
get
- Returns:
- value of attribute
get
-
init
- Returns:
- value of attribute
init
-
with
- Returns:
- value of attribute
with
-
withUnaryOperator
- Returns:
- value of attribute
withUnaryOperator
-
add
- Returns:
- value of attribute
add
-
addAll
- Returns:
- value of attribute
addAll
-
put
- Returns:
- value of attribute
put
-
putAll
- Returns:
- value of attribute
putAll
-
copyOf
- Returns:
- value of attribute
copyOf
-
of
- Returns:
- value of attribute
of
-
instance
- Returns:
- value of attribute
instance
-
builder
- Returns:
- value of attribute
builder
-
newBuilder
- Returns:
- value of attribute
newBuilder
-
from
- Returns:
- value of attribute
from
-
build
- Returns:
- value of attribute
build
-
buildOrThrow
- Returns:
- value of attribute
buildOrThrow
-
canBuild
- Returns:
- value of attribute
canBuild
-
toBuilder
- Returns:
- value of attribute
toBuilder
-
underrideHashCode
- Returns:
- value of attribute
underrideHashCode
-
underrideEquals
- Returns:
- value of attribute
underrideEquals
-
underrideToString
- Returns:
- value of attribute
underrideToString
-
delegateToString
- Returns:
- value of attribute
delegateToString
-
includeHashCode
- Returns:
- value of attribute
includeHashCode
-
isInitialized
- Returns:
- value of attribute
isInitialized
-
isSet
- Returns:
- value of attribute
isSet
-
set
- Returns:
- value of attribute
set
-
unset
- Returns:
- value of attribute
unset
-
clear
- Returns:
- value of attribute
clear
-
create
- Returns:
- value of attribute
create
-
toImmutable
- Returns:
- value of attribute
toImmutable
-
typeBuilder
- Returns:
- value of attribute
typeBuilder
-
typeInnerBuilder
- Returns:
- value of attribute
typeInnerBuilder
-
typeAbstract
- Returns:
- value of attribute
typeAbstract
-
typeImmutable
- Returns:
- value of attribute
typeImmutable
-
typeImmutableEnclosing
- Returns:
- value of attribute
typeImmutableEnclosing
-
typeImmutableNested
- Returns:
- value of attribute
typeImmutableNested
-
typeModifiable
- Returns:
- value of attribute
typeModifiable
-
typeInnerModifiable
- Returns:
- value of attribute
typeInnerModifiable
-
typeWith
- Returns:
- value of attribute
typeWith
-
packageGenerated
- Returns:
- value of attribute
packageGenerated
-
defaultsMirror
- Returns:
- annotation mirror for value of attribute
defaults
-
defaults
- Returns:
- reified annotation mirror for
ValueMirrors.Immutable
-
strictBuilder
public boolean strictBuilder()- Returns:
- value of attribute
strictBuilder
-
strictModifiable
public boolean strictModifiable()- Returns:
- value of attribute
strictModifiable
-
validationMethod
- Returns:
- value of attribute
validationMethod
-
allParameters
public boolean allParameters()- Returns:
- value of attribute
allParameters
-
defaultAsDefault
public boolean defaultAsDefault()- Returns:
- value of attribute
defaultAsDefault
-
headerComments
public boolean headerComments()- Returns:
- value of attribute
headerComments
-
jdkOnly
public boolean jdkOnly()- Returns:
- value of attribute
jdkOnly
-
jdk9Collections
public boolean jdk9Collections()- Returns:
- value of attribute
jdk9Collections
-
passAnnotationsName
- Returns:
- type name for value of attribute
passAnnotations
-
passAnnotationsMirror
- Returns:
- type mirror for value of attribute
passAnnotations
-
passAnnotations
Deprecated.Always throws UnsupportedOperationException. UsepassAnnotationsMirror()orpassAnnotationsName. -
additionalJsonAnnotationsName
- Returns:
- type name for value of attribute
additionalJsonAnnotations
-
additionalJsonAnnotationsMirror
- Returns:
- type mirror for value of attribute
additionalJsonAnnotations
-
additionalJsonAnnotations
Deprecated.Always throws UnsupportedOperationException. UseadditionalJsonAnnotationsMirror()oradditionalJsonAnnotationsName. -
visibility
- Returns:
- value of attribute
visibility
-
visibilityString
- Returns:
- value of attribute
visibilityString
-
optionalAcceptNullable
public boolean optionalAcceptNullable()- Returns:
- value of attribute
optionalAcceptNullable
-
generateSuppressAllWarnings
public boolean generateSuppressAllWarnings()- Returns:
- value of attribute
generateSuppressAllWarnings
-
privateNoargConstructor
public boolean privateNoargConstructor()- Returns:
- value of attribute
privateNoargConstructor
-
protectedNoargConstructor
public boolean protectedNoargConstructor()- Returns:
- value of attribute
protectedNoargConstructor
-
attributelessSingleton
public boolean attributelessSingleton()- Returns:
- value of attribute
attributelessSingleton
-
unsafeDefaultAndDerived
public boolean unsafeDefaultAndDerived()- Returns:
- value of attribute
unsafeDefaultAndDerived
-
clearBuilder
public boolean clearBuilder()- Returns:
- value of attribute
clearBuilder
-
deferCollectionAllocation
public boolean deferCollectionAllocation()- Returns:
- value of attribute
deferCollectionAllocation
-
deepImmutablesDetection
public boolean deepImmutablesDetection()- Returns:
- value of attribute
deepImmutablesDetection
-
overshadowImplementation
public boolean overshadowImplementation()- Returns:
- value of attribute
overshadowImplementation
-
implementationNestedInBuilder
public boolean implementationNestedInBuilder()- Returns:
- value of attribute
implementationNestedInBuilder
-
forceJacksonPropertyNames
public boolean forceJacksonPropertyNames()- Returns:
- value of attribute
forceJacksonPropertyNames
-
forceJacksonIgnoreFields
public boolean forceJacksonIgnoreFields()- Returns:
- value of attribute
forceJacksonIgnoreFields
-
forceEqualsInWithers
public boolean forceEqualsInWithers()- Returns:
- value of attribute
forceEqualsInWithers
-
jacksonIntegration
public boolean jacksonIntegration()- Returns:
- value of attribute
jacksonIntegration
-
weakInterning
public boolean weakInterning()- Returns:
- value of attribute
weakInterning
-
alwaysPublicInitializers
public boolean alwaysPublicInitializers()- Returns:
- value of attribute
alwaysPublicInitializers
-
builderVisibility
- Returns:
- value of attribute
builderVisibility
-
builderVisibilityString
- Returns:
- value of attribute
builderVisibilityString
-
throwForInvalidImmutableStateName
- Returns:
- type name for value of attribute
throwForInvalidImmutableState
-
throwForInvalidImmutableStateMirror
- Returns:
- type mirror for value of attribute
throwForInvalidImmutableState
-
throwForInvalidImmutableState
Deprecated.Always throws UnsupportedOperationException. UsethrowForInvalidImmutableStateMirror()orthrowForInvalidImmutableStateName. -
throwForNullPointerName
- Returns:
- type name for value of attribute
throwForNullPointer
-
throwForNullPointerMirror
- Returns:
- type mirror for value of attribute
throwForNullPointer
-
throwForNullPointer
Deprecated.Always throws UnsupportedOperationException. UsethrowForNullPointerMirror()orthrowForNullPointerName. -
depluralize
public boolean depluralize()- Returns:
- value of attribute
depluralize
-
depluralizeDictionary
- Returns:
- value of attribute
depluralizeDictionary
-
immutableCopyOfRoutinesName
- Returns:
- type name for value of attribute
immutableCopyOfRoutines
-
immutableCopyOfRoutinesMirror
- Returns:
- type mirror for value of attribute
immutableCopyOfRoutines
-
immutableCopyOfRoutines
Deprecated.Always throws UnsupportedOperationException. UseimmutableCopyOfRoutinesMirror()orimmutableCopyOfRoutinesName. -
stagedBuilder
public boolean stagedBuilder()- Returns:
- value of attribute
stagedBuilder
-
builtinContainerAttributes
public boolean builtinContainerAttributes()- Returns:
- value of attribute
builtinContainerAttributes
-
beanFriendlyModifiables
public boolean beanFriendlyModifiables()- Returns:
- value of attribute
beanFriendlyModifiables
-
allMandatoryParameters
public boolean allMandatoryParameters()- Returns:
- value of attribute
allMandatoryParameters
-
redactedMask
- Returns:
- value of attribute
redactedMask
-
attributeBuilderDetection
public boolean attributeBuilderDetection()- Returns:
- value of attribute
attributeBuilderDetection
-
transientDerivedFields
public boolean transientDerivedFields()- Returns:
- value of attribute
transientDerivedFields
-
finalInstanceFields
public boolean finalInstanceFields()- Returns:
- value of attribute
finalInstanceFields
-
attributeBuilder
- Returns:
- value of attribute
attributeBuilder
-
getBuilder
- Returns:
- value of attribute
getBuilder
-
setBuilder
- Returns:
- value of attribute
setBuilder
-
addBuilder
- Returns:
- value of attribute
addBuilder
-
addAllBuilder
- Returns:
- value of attribute
addAllBuilder
-
getBuilders
- Returns:
- value of attribute
getBuilders
-
nullableAnnotation
- Returns:
- value of attribute
nullableAnnotation
-
limitStringLengthInToString
public int limitStringLengthInToString()- Returns:
- value of attribute
limitStringLengthInToString
-
allowedClasspathAnnotationsName
- Returns:
- type name for value of attribute
allowedClasspathAnnotations
-
allowedClasspathAnnotationsMirror
- Returns:
- type mirror for value of attribute
allowedClasspathAnnotations
-
allowedClasspathAnnotations
Deprecated.Always throws UnsupportedOperationException. UseallowedClasspathAnnotationsMirror()orallowedClasspathAnnotationsName. -
fallbackNullableAnnotationName
- Returns:
- type name for value of attribute
fallbackNullableAnnotation
-
fallbackNullableAnnotationMirror
- Returns:
- type mirror for value of attribute
fallbackNullableAnnotation
-
fallbackNullableAnnotation
Deprecated.Always throws UnsupportedOperationException. UsefallbackNullableAnnotationMirror()orfallbackNullableAnnotationName. -
jakarta
public boolean jakarta()- Returns:
- value of attribute
jakarta
-
getAnnotationMirror
- Returns:
- underlying annotation mirror
-
annotationType
- Specified by:
annotationTypein interfaceAnnotation- Returns:
Style.class
-
hashCode
public int hashCode()- Specified by:
hashCodein interfaceAnnotation- Overrides:
hashCodein classObject
-
equals
- Specified by:
equalsin interfaceAnnotation- Overrides:
equalsin classObject
-
toString
- Specified by:
toStringin interfaceAnnotation- Overrides:
toStringin classObject
-