org.cornutum.annotation

Class PackageFilter

java.lang.Object

org.cornutum.annotation.PackageFilter

All Implemented Interfaces:

AnnotationFilter

public class PackageFilter
extends Object
implements AnnotationFilter

An AnnotationFilter that accepts annotated elements appearing in classes that belong to specific packages.

Constructor Summary

Constructors

Constructor and Description
PackageFilter() Creates a new SimpleAnnotationFilter instance.
PackageFilter(Class<? extends Annotation>... annotations) Creates a new SimpleAnnotationFilter instance.
PackageFilter(String... annotations) Creates a new SimpleAnnotationFilter instance.

Method Summary

Modifier and Type	Method and Description
Optional<String>	acceptAnnotation(String rawTypeName) If the given raw type name identifies an accepted Annotation, returns the annotation class.
boolean	acceptClass(String className) Returns true if the given class belongs to an accepted package.
PackageFilter	annotation(Class<? extends Annotation>... annotations) Adds to the set of accepted annotations.
PackageFilter	annotation(String... annotations) Adds to the set of accepted annotations.
Set<String>	getAnnotations() Returns the annotations accepted by this filter.
Set<String>	getPackages() Returns the packages accepted by this filter.
PackageFilter	inPackage(Collection<String> packageNames) Adds to the set of accepted packages.
PackageFilter	inPackage(String... packageNames) Adds to the set of accepted packages.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PackageFilter

public PackageFilter()

Creates a new SimpleAnnotationFilter instance.

PackageFilter

@SafeVarargs
public PackageFilter(Class<? extends Annotation>... annotations)

Creates a new SimpleAnnotationFilter instance.

PackageFilter

public PackageFilter(String... annotations)

Creates a new SimpleAnnotationFilter instance.

Method Detail

annotation

@SafeVarargs
public final PackageFilter annotation(Class<? extends Annotation>... annotations)

Adds to the set of accepted annotations.

annotation

public PackageFilter annotation(String... annotations)

Adds to the set of accepted annotations.

inPackage

public PackageFilter inPackage(String... packageNames)

Adds to the set of accepted packages.

inPackage

public PackageFilter inPackage(Collection<String> packageNames)

Adds to the set of accepted packages.

getAnnotations

public Set<String> getAnnotations()

Returns the annotations accepted by this filter.

getPackages

public Set<String> getPackages()

Returns the packages accepted by this filter.

acceptAnnotation

public Optional<String> acceptAnnotation(String rawTypeName)

If the given raw type name identifies an accepted Annotation, returns the annotation class. Otherwise, returns empty.

Specified by:

acceptAnnotation in interface AnnotationFilter

acceptClass

public boolean acceptClass(String className)

Returns true if the given class belongs to an accepted package. If no accepted package has been defined, returns true for any packageName.

Specified by:

acceptClass in interface AnnotationFilter

toString

public String toString()

Overrides:

toString in class Object