Package com.helger.commons.annotation

Enum Summary

Enum	Description
ELockType	The locking type to be used in the IsLocked and MustBeLocked annotations.

Annotation Types Summary

Annotation Type	Description
CodingStyleguideUnaware	This is an indicator, that an object is aware to break the style guide.
ContainsSoftMigration	This is a source-only indicator for objects that contain soft migration.
DevelopersNote	Just a debugging measurement to add comments to all elements.
IsLocked	For methods to be overridden, it indicates, that the method is locked.
IsSPIImplementation	Marker interface that claims that this class implements an SPI interface that is resolved via the ServiceLoader.
IsSPIInterface	Marker interface that claims that implementations of this interface are loaded via the ServiceLoader.
LazilyInitialized	This is an indicator, that a field is lazily initialized.
MustBeLocked	Just to indicate that a method must be called inside a lock.
MustImplementComparable	Just to indicate that a class is required to implement Comparable.
MustImplementEqualsAndHashcode	Just to indicate that a class is required to implement Annotation.equals(Object) and Annotation.hashCode().
Nonempty	A specialization of the Nonnull annotation that is to be used for String and collection parameters as well as return values only.
NoTranslationRequired	An informational annotation that indicates that a type does not require translation.
OverrideOnDemand	Just to indicate that a method is meant to be overridden in sub classes.
PresentForCodeCoverage	Just to indicate that an object is only present for code coverage reasons, to create 100% coverage.
PrivateAPI	Indicate that a public element is not meant for public use, but only for project internal use.
ReturnsImmutableObject	Indicates that a method returns an immutable object (in case the returned type itself is not immutable).
ReturnsMutableCopy	Indicates that a method returns a mutable object but containing a copy of the internal state.
ReturnsMutableObject	Indicates that a method returns a mutable object.
Since	A code comment for elements that were added at a specific version.
Singleton	Just to indicate that a class is a singleton and therefore only a single instance of the class exists.
Translatable	An informational annotation that indicates that something is meant to be translated.
UnsafeAPI	Indicate methods that are unsafe but are helpful in very rare scenarios.
UnsupportedOperation	Indicate methods that are supposed to throw an UnsupportedOperationException.
Until	A code comment for elements that were removed at a specific version.
UseDirectEqualsAndHashCode	Indicate that a class's native implementations of Annotation.equals(Object) and Annotation.hashCode() should be used and no wrapper.
UsedViaReflection	Just to indicate that a class is used via reflection and not by direct references.
VisibleForTesting	Indicates that a method has only increased visibility for testing purposes.
WorkInProgress	This annotation defines that an element is "work in progress" and should not yet be used in production.