Package org.codehaus.mojo.animal_sniffer

Class SignatureChecker

java.lang.Object

org.codehaus.mojo.animal_sniffer.ClassFileVisitor

org.codehaus.mojo.animal_sniffer.SignatureChecker

public class SignatureChecker
extends ClassFileVisitor

Checks the signature against classes in this list.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	SignatureChecker.CheckingVisitor
private static class	SignatureChecker.ExactMatchRule
private static interface	SignatureChecker.MatchRule
private static class	SignatureChecker.PrefixMatchRule
private static class	SignatureChecker.RegexMatchRule

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANNOTATION_FQN	The fully qualified name of the annotation to use to annotate methods/fields/classes that are to be ignored by animal sniffer.
private Collection<String>	annotationDescriptors
private final Map<String,Clazz>	classes
private boolean	hadError
private final Set<String>	ignoredOuterClassesOrMethods
private final List<SignatureChecker.MatchRule>	ignoredPackageRules	Classes in this packages are considered to be resolved elsewhere and thus not a subject of the error checking when referenced.
private final Set<String>	ignoredPackages
private final Logger	logger
static final String	PREVIOUS_ANNOTATION_FQN	Similar to ANNOTATION_FQN.
private List<File>	sourcePath

Constructor Summary

Constructors

Constructor	Description
SignatureChecker(InputStream in, Set<String> ignoredPackages, Logger logger)
SignatureChecker(Map<String,Clazz> classes, Set<String> ignoredPackages, Logger logger)

Method Summary

Modifier and Type	Method	Description
private static String	fromSourceType(String text)
boolean	isSignatureBroken()
static Map<String,Clazz>	loadClasses(InputStream in)
static void	main(String[] args)
private SignatureChecker.MatchRule	newMatchRule(String matcher)
protected void	process(String name, InputStream image)
void	setAnnotationTypes(Collection<String> annotationTypes)	Sets the annotation type(s) that this checker should consider to ignore annotated methods, classes or fields.
void	setSourcePath(List<File> sourcePath)
(package private) static String	toAnnotationDescriptor(String classFqn)
(package private) static String	toSourceForm(String type, String sig)
private static String	toSourceType(String text)
private static String	toSourceType(CharBuffer type)

Methods inherited from class org.codehaus.mojo.animal_sniffer.ClassFileVisitor

isCheckJars, process, process, process, processClassFile, processDirectory, processJarFile, setCheckJars

Methods inherited from class java.lang.Object

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

Field Details

ANNOTATION_FQN

public static final String ANNOTATION_FQN

The fully qualified name of the annotation to use to annotate methods/fields/classes that are to be ignored by animal sniffer.

See Also:

• Constant Field Values

PREVIOUS_ANNOTATION_FQN

public static final String PREVIOUS_ANNOTATION_FQN

Similar to ANNOTATION_FQN. Kept for backward compatibility reasons

See Also:

• Constant Field Values

classes

private final Map<String,Clazz> classes

logger

private final Logger logger

ignoredPackageRules

private final List<SignatureChecker.MatchRule> ignoredPackageRules

Classes in this packages are considered to be resolved elsewhere and thus not a subject of the error checking when referenced.

ignoredPackages

private final Set<String> ignoredPackages

ignoredOuterClassesOrMethods

private final Set<String> ignoredOuterClassesOrMethods

hadError

private boolean hadError

sourcePath

private List<File> sourcePath

annotationDescriptors

private Collection<String> annotationDescriptors

Constructor Details

SignatureChecker

public SignatureChecker(InputStream in,
 Set<String> ignoredPackages,
 Logger logger)
                 throws IOException

Throws:

IOException

SignatureChecker

public SignatureChecker(Map<String,Clazz> classes,
 Set<String> ignoredPackages,
 Logger logger)
                 throws IOException

Throws:

IOException

Method Details

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

loadClasses

public static Map<String,Clazz> loadClasses(InputStream in)
                                     throws IOException

Throws:

IOException

setSourcePath

public void setSourcePath(List<File> sourcePath)

Since:

1.9

setAnnotationTypes

public void setAnnotationTypes(Collection<String> annotationTypes)

Sets the annotation type(s) that this checker should consider to ignore annotated methods, classes or fields.

By default, the ANNOTATION_FQN and PREVIOUS_ANNOTATION_FQN are used.

If you want to add an extra annotation types, make sure to add the standard one to the specified lists.

Parameters:

annotationTypes - a list of the fully qualified name of the annotation types to consider for ignoring annotated method, class and field

Since:

1.11

process

protected void process(String name,
 InputStream image)
                throws IOException

Specified by:

process in class ClassFileVisitor

Parameters:

name - Displayable name to identify what class file we are processing

image - Class file image.

Throws:

IOException

newMatchRule

private SignatureChecker.MatchRule newMatchRule(String matcher)

isSignatureBroken

public boolean isSignatureBroken()

toSourceForm

static String toSourceForm(String type,
 String sig)

toAnnotationDescriptor

static String toAnnotationDescriptor(String classFqn)

toSourceType

private static String toSourceType(CharBuffer type)

toSourceType

private static String toSourceType(String text)

fromSourceType

private static String fromSourceType(String text)