Module io.annot8.core

Package io.annot8.core.capabilities

Class AnnotationCapability

java.lang.Object

io.annot8.core.capabilities.AnnotationCapability

public class AnnotationCapability
extends Object

Specification for annotation created, processed or deleted by a component.

Note that optional will be set to true for create and delete operations. This reflects that typically we may or may not create/delete elements, even if all the prerequisites are met.

Constructor Summary

Constructors

Constructor	Description
AnnotationCapability(CreatesAnnotation annotation)	Create from CreatesAnnotation
AnnotationCapability(DeletesAnnotation annotation)	Create from DeletesAnnotation
AnnotationCapability(ProcessesAnnotation annotation)	Create from ProcessesAnnotation
AnnotationCapability(String type, Class<? extends Bounds> bounds, boolean optional)	Create from fields

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Class<? extends Bounds>	getBounds()	Get the bounds created/deleted/processed
String	getType()	Get the annotation type created/deleted/processed
int	hashCode()
boolean	isOptional()	Is the annotation defined by this object optionally (required for processing, created, deleted)

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationCapability

public AnnotationCapability(CreatesAnnotation annotation)

Create from CreatesAnnotation

Parameters:

annotation - the annotation

AnnotationCapability

public AnnotationCapability(DeletesAnnotation annotation)

Create from DeletesAnnotation

Parameters:

annotation - the annotation

AnnotationCapability

public AnnotationCapability(ProcessesAnnotation annotation)

Create from ProcessesAnnotation

Parameters:

annotation - the annotation

AnnotationCapability

public AnnotationCapability(String type,
                            Class<? extends Bounds> bounds,
                            boolean optional)

Create from fields

Parameters:

type - the annotation type

bounds - the annotation bounds

optional - whether the above are required (processing specific)

Method Detail

getType

public String getType()

Get the annotation type created/deleted/processed

Returns:

annotation type

getBounds

public Class<? extends Bounds> getBounds()

Get the bounds created/deleted/processed

Returns:

the class of bounds

isOptional

public boolean isOptional()

Is the annotation defined by this object optionally (required for processing, created, deleted)

Returns:

true if optional

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object