net.openhft.chronicle.core.annotation (OpenHFT/Chronicle Core 2.27ea0 API)

Annotation Types Summary
Annotation Type	Description
ChronicleFeature
DontChain	This annotation, when applied to an interface, instructs that the interface should not be considered when MethodReaders and MethodWriters are exploring interfaces to implement.
ForceInline	Marker annotation for some methods and constructors in the JSR 292 implementation.
HotMethod
Java9	Marker annotation to label methods that are expected to be called by java-9+ specific code paths.
Negative	Annotation that indicates the annotated element is expected to hold a negative value (i.e.
NonNegative	Annotation that indicates the annotated element is expected to hold a non-negative value (i.e.
NonPositive	Annotation that indicates the annotated element is expected to hold a non-positive value (i.e.
PackageLocal	Annotation to indicate that the annotated element has package-local visibility intentionally, usually to avoid accessor methods.
Positive	Annotation that indicates the annotated element is expected to hold a positive value (i.e.
Range	Indicates that the annotated element is expected to hold a value within a specified range [from, to), where the "from" value is inclusive and the "to" value is exclusive (i.e.
RequiredForClient	Indicates that modifications to the annotated class should be made with caution as it is known to be used by a client.
ScopeConfined	Indicates that the value consumer, value mapper, structure etc.
SingleThreaded	Annotation to document that a class is intended to be used in a single-threaded context.
TargetMajorVersion	Annotation to specify the target major version for the annotated type.
UsedViaReflection	Annotation to indicate that the annotated member is accessed via reflection, or that it must be public for tests to work.

Package net.openhft.chronicle.core.annotation Description

Provides annotations for specifying and documenting constraints, expected behavior, and meta-information for elements within the Chronicle Core library.

The annotations in this package can be used for a range of purposes such as:

Specifying expected value ranges or conditions for variables and parameters.
Documenting intended usage scenarios, such as single-threaded access.
Conveying information about the design decisions, such as package-local access.
Indicating implications of modifying elements referred to by clients or accessed through reflection.

Examples of annotations provided in this package include:

These annotations may be used to convey intentions, constraints, and additional information about elements in the codebase which can be beneficial for documentation, analysis or runtime behavior.