Package org.apache.juneau.commons.annotation

Class AppliedAnnotationObject

java.lang.Object

org.apache.juneau.commons.annotation.AnnotationObject

org.apache.juneau.commons.annotation.AppliedAnnotationObject

All Implemented Interfaces:

Annotation

Direct Known Subclasses:

AppliedOnClassAnnotationObject

public class AppliedAnnotationObject
extends AnnotationObject

An implementation of an annotation that can be dynamically applied to classes, methods, fields, and constructors at runtime.

This class extends AnnotationObject to provide support for annotations that have an on property which allows them to be targeted to specific program elements based on their fully-qualified names.

Overview:

Applied annotations allow you to define annotation properties in external configuration or programmatically at runtime, rather than requiring them to be declared directly on classes, methods, fields, or constructors at compile-time.

This is particularly useful for:

• Configuration-driven behavior - Define annotation properties in config files without modifying source code
• Dynamic application - Apply annotations to third-party classes where you can't modify the source
• Runtime customization - Change annotation properties based on runtime conditions
• Centralized configuration - Define annotation properties for multiple classes in one place

Targeting with on:

The base AppliedAnnotationObject.Builder.on(String...) method accepts fully-qualified names in the following formats:

• "com.example.MyClass" - Target a specific class
• "com.example.MyClass.myMethod" - Target a specific method
• "com.example.MyClass.myField" - Target a specific field
• "com.example.MyClass(java.lang.String,int)" - Target a specific constructor

Builder Variants:

This class provides specialized builder variants for different targeting scenarios:

• AppliedAnnotationObject.Builder - Base builder with string-based targeting via AppliedAnnotationObject.Builder.on(String...)
• AppliedAnnotationObject.BuilderT - For targeting classes
  • on(Class...) - Target by class, stored as strings
  • on(ClassInfo...) - Target by ClassInfo, stored as strings
  • onClass(Class...) - Target by class, stored as Class objects
  • onClass(ClassInfo...) - Target by ClassInfo, stored as Class objects
• AppliedAnnotationObject.BuilderM - For targeting methods
  • on(Method...) - Target by Method object
  • on(MethodInfo...) - Target by MethodInfo object
• AppliedAnnotationObject.BuilderC - For targeting constructors
  • on(Constructor...) - Target by Constructor object
  • on(ConstructorInfo...) - Target by ConstructorInfo object
• AppliedAnnotationObject.BuilderMF - For targeting methods and fields
  • on(Method...) - Target by Method object
  • on(MethodInfo...) - Target by MethodInfo object
  • on(Field...) - Target by Field object
  • on(FieldInfo...) - Target by FieldInfo object
• AppliedAnnotationObject.BuilderTM - For targeting classes and methods
• AppliedAnnotationObject.BuilderTMF - For targeting classes, methods, and fields
• AppliedAnnotationObject.BuilderTMFC - For targeting classes, methods, fields, and constructors

Example:

// Create a Bean annotation that applies to MyClass BeanAnnotation annotation = BeanAnnotation .create(MyClass.class) .sort(true) .build(); // Or target by string name BeanAnnotation annotation2 = BeanAnnotation .create() .on("com.example.MyClass") .sort(true) .build();

Notes:

• The on() method returns the string-based targets
• Subclasses may provide additional onClass(), onMethod(), etc. methods for type-safe access
• All builder methods return the builder for method chaining
• Hashcode is calculated lazily on first access and then cached for performance

See Also:

• Overview > juneau-commons > Annotations

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AppliedAnnotationObject.Builder	Builder for AppliedAnnotationObject objects.
static class	AppliedAnnotationObject.BuilderC	Builder for applied annotations targeting constructors.
static class	AppliedAnnotationObject.BuilderM	Builder for applied annotations targeting methods.
static class	AppliedAnnotationObject.BuilderMF	Builder for applied annotations targeting methods and fields.
static class	AppliedAnnotationObject.BuilderT	Builder for applied annotations targeting classes.
static class	AppliedAnnotationObject.BuilderTM	Builder for applied annotations targeting classes and methods.
static class	AppliedAnnotationObject.BuilderTMF	Builder for applied annotations targeting classes, methods, and fields.
static class	AppliedAnnotationObject.BuilderTMFC	Builder for applied annotations targeting classes, methods, fields, and constructors.

Constructor Summary

Constructors

Constructor	Description
AppliedAnnotationObject(AppliedAnnotationObject.Builder b)	Constructor.

Method Summary

Modifier and Type	Method	Description
String[]	on()	The targets this annotation applies to.

Methods inherited from class org.apache.juneau.commons.annotation.AnnotationObject

annotationType, equals, hashCode, propertyMap, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AppliedAnnotationObject

public AppliedAnnotationObject(AppliedAnnotationObject.Builder b)

Constructor.

Parameters:

b - The builder used to instantiate the fields of this class.

Method Details

on

public String[] on()

The targets this annotation applies to.

Returns:

The targets this annotation applies to.