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.

Author:

Kohsuke Kawaguchi

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.
static final String	PREVIOUS_ANNOTATION_FQN	Similar to ANNOTATION_FQN.

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
boolean	isSignatureBroken()
static Map<String,Clazz>	loadClasses(InputStream in)
static void	main(String[] args)
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)

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

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

isSignatureBroken

public boolean isSignatureBroken()