Package adams.core.annotation

Class ThirdPartyCopyrightProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

adams.core.annotation.AbstractCopyrightProcessor<ThirdPartyCopyright>

adams.core.annotation.ThirdPartyCopyrightProcessor

All Implemented Interfaces:

Processor

@SupportedOptions({"module","output","printheader"})
public class ThirdPartyCopyrightProcessor
extends AbstractCopyrightProcessor<ThirdPartyCopyright>

A processor that lists all classes/methods with 3rd party copyright.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

MixedCopyright

Field Summary

Fields inherited from class adams.core.annotation.AbstractCopyrightProcessor

m_IsFirst

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
ThirdPartyCopyrightProcessor()

Method Summary

Modifier and Type	Method	Description
protected Class	getAnnotationClass()	Returns the annotation class to process.
protected String	getDataRow(ThirdPartyCopyright copyright, String module, String cls, String method)	Returns a data row for a specific annotation.
protected String	getHeaderRow()	Returns the header row for the tab-separated output file.
protected String	getOutputFile(String prefix)	Returns the output file to write the information to.

Methods inherited from class adams.core.annotation.AbstractCopyrightProcessor

getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, process

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, init, isInitialized

Methods inherited from class java.lang.Object

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

Constructor Detail

ThirdPartyCopyrightProcessor

public ThirdPartyCopyrightProcessor()

Method Detail

getAnnotationClass

protected Class getAnnotationClass()

Returns the annotation class to process.

Specified by:

getAnnotationClass in class AbstractCopyrightProcessor<ThirdPartyCopyright>

Returns:

the class

getOutputFile

protected String getOutputFile(String prefix)

Returns the output file to write the information to.

Specified by:

getOutputFile in class AbstractCopyrightProcessor<ThirdPartyCopyright>

Parameters:

prefix - the path/filename prefix

Returns:

the full path/filename

getHeaderRow

protected String getHeaderRow()

Returns the header row for the tab-separated output file.

Specified by:

getHeaderRow in class AbstractCopyrightProcessor<ThirdPartyCopyright>

Returns:

the header row

getDataRow

protected String getDataRow(ThirdPartyCopyright copyright,
                            String module,
                            String cls,
                            String method)

Returns a data row for a specific annotation.

Specified by:

getDataRow in class AbstractCopyrightProcessor<ThirdPartyCopyright>

Parameters:

copyright - the copyright annotation to use

module - the module to use

cls - the class the annotation is located in

method - the method the annotation is located in, empty string if not applicable