Package org.jboss.forge.roaster.model.source

Interface AnnotationTargetSource<O extends JavaSource<O>,T>

All Superinterfaces:

AnnotationTarget<O>, Internal, Origin<O>

All Known Subinterfaces:

AnnotationElementSource, EnumConstantSource, EnumConstantSource.Body, FieldSource<O>, JavaAnnotationSource, JavaClassSource, JavaEnumSource, JavaInterfaceSource, JavaPackageInfoSource, JavaRecordComponentSource, JavaRecordSource, JavaSource<T>, MemberSource<O,T>, MethodSource<O>, ParameterSource<O>

public interface AnnotationTargetSource<O extends JavaSource<O>,T>
extends AnnotationTarget<O>

Represents a Java source element that may carry annotations.

Author:

Lincoln Baxter, III

Method Summary

Modifier and Type	Method	Description
AnnotationSource<O>	addAnnotation()	Add a new annotation instance to this AnnotationTargetSource (note that an import statement must be added manually if required).
AnnotationSource<O>	addAnnotation(Class<? extends Annotation> type)	Add a new annotation instance to this AnnotationTargetSource, using the given Class as the annotation type.
AnnotationSource<O>	addAnnotation(String className)	Add a new annotation instance to this AnnotationTargetSource, using the given String className as the annotation type.
AnnotationSource<O>	getAnnotation(Class<? extends Annotation> type)	Returns the annotation bound of the given type in this AnnotationTarget or null if it doesn't exist
AnnotationSource<O>	getAnnotation(String type)	Returns the annotation bound of the given type in this AnnotationTarget or null if it doesn't exist
List<AnnotationSource<O>>	getAnnotations()	Returns a List of Annotation elements bound to this AnnotationTarget instance
void	removeAllAnnotations()	Remove all annotations instance from this AnnotationTargetSource.
T	removeAnnotation(Annotation<O> annotation)	Remove an annotation instance from this AnnotationTargetSource.

Methods inherited from interface org.jboss.forge.roaster.model.AnnotationTarget

hasAnnotation, hasAnnotation

Methods inherited from interface org.jboss.forge.roaster.Internal

getInternal

Methods inherited from interface org.jboss.forge.roaster.Origin

getOrigin

Method Details

getAnnotations

List<AnnotationSource<O>> getAnnotations()

Description copied from interface: AnnotationTarget

Returns a List of Annotation elements bound to this AnnotationTarget instance

Specified by:

getAnnotations in interface AnnotationTarget<O extends JavaSource<O>>

getAnnotation

AnnotationSource<O> getAnnotation(Class<? extends Annotation> type)

Description copied from interface: AnnotationTarget

Returns the annotation bound of the given type in this AnnotationTarget or null if it doesn't exist

Specified by:

getAnnotation in interface AnnotationTarget<O extends JavaSource<O>>

Parameters:

type - The Annotation type

getAnnotation

AnnotationSource<O> getAnnotation(String type)

Description copied from interface: AnnotationTarget

Returns the annotation bound of the given type in this AnnotationTarget or null if it doesn't exist

Specified by:

getAnnotation in interface AnnotationTarget<O extends JavaSource<O>>

Parameters:

type - The FQN of the annotation

addAnnotation

AnnotationSource<O> addAnnotation()

Add a new annotation instance to this AnnotationTargetSource (note that an import statement must be added manually if required).

addAnnotation

AnnotationSource<O> addAnnotation(Class<? extends Annotation> type)

Add a new annotation instance to this AnnotationTargetSource, using the given Class as the annotation type. Attempt to add an import statement to this object's AnnotationTargetSource if required.

addAnnotation

AnnotationSource<O> addAnnotation(String className)

Add a new annotation instance to this AnnotationTargetSource, using the given String className as the annotation type. Attempt to add an import statement to this object's AnnotationTargetSource if required (note that the given className must be fully-qualified in order to properly import required classes).

removeAnnotation

T removeAnnotation(Annotation<O> annotation)

Remove an annotation instance from this AnnotationTargetSource.

removeAllAnnotations

void removeAllAnnotations()

Remove all annotations instance from this AnnotationTargetSource.