org.myire.quill.cpd

Class CpdParameters

java.lang.Object

org.myire.quill.cpd.CpdParameters

public class CpdParameters
extends java.lang.Object

The parameters that can be passed to A CpdRunner to control the CPD analysis.

Constructor Summary

Constructors

Constructor and Description
CpdParameters()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEncoding() Get the encoding used by CPD to read the source files and to produce the report.
java.lang.String	getLanguage() Get the language of the source files to analyze, e.g.
int	getMinimumTokenCount() The minimum duplicate size to be reported.
java.lang.String	getSkipBlocksPattern() Specifies the pattern to find the blocks to skip when skipBlocks is true.
boolean	isIgnoreAnnotations() If true, annotations will be ignored.
boolean	isIgnoreIdentifiers() If true, differences in identifiers (like variable names or methods names) will be ignored in the same way as literals in isIgnoreLiterals().
boolean	isIgnoreLiterals() If true, CPD ignores literal value differences when evaluating a duplicate block.
boolean	isIgnoreUsings() If true, using directives in C# will be ignored when comparing text.
boolean	isSkipBlocks() If true, skipping of blocks is enabled with the patterns specified in the skipBlocksPattern property.
boolean	isSkipDuplicateFiles() If true, CPD will ignore multiple copies of files with the same name and length.
boolean	isSkipLexicalErrors() If true, CPD will skip files which can't be tokenized due to invalid characters instead of aborting the analysis.
void	setEncoding(java.lang.String pEncoding)
void	setIgnoreAnnotations(boolean pIgnoreAnnotations)
void	setIgnoreIdentifiers(boolean pIgnoreIdentifiers)
void	setIgnoreLiterals(boolean pIgnoreLiterals)
void	setIgnoreUsings(boolean pIgnoreUsings)
void	setLanguage(java.lang.String pLanguage)
void	setMinimumTokenCount(int pMinimumTokenCount)
void	setSkipBlocks(boolean pSkipBlocks)
void	setSkipBlocksPattern(java.lang.String pSkipBlocksPattern)
void	setSkipDuplicateFiles(boolean pSkipDuplicateFiles)
void	setSkipLexicalErrors(boolean pSkipLexicalErrors)

Methods inherited from class java.lang.Object

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

Constructor Detail

CpdParameters

public CpdParameters()

Method Detail

getLanguage

public java.lang.String getLanguage()

Get the language of the source files to analyze, e.g. "cpp", "java", "php", "ruby", or "ecmascript". See the CPD documentation for the list of languages supported by the different versions of CPD. The default is "java".

Returns:

The language.

setLanguage

public void setLanguage(java.lang.String pLanguage)

getEncoding

public java.lang.String getEncoding()

Get the encoding used by CPD to read the source files and to produce the report. The platform's default encoding will be used if this parameter isn't specified.

Returns:

The source file encoding.

setEncoding

public void setEncoding(java.lang.String pEncoding)

getMinimumTokenCount

public int getMinimumTokenCount()

The minimum duplicate size to be reported. The default is 100.

Returns:

The minimum duplicate size.

setMinimumTokenCount

public void setMinimumTokenCount(int pMinimumTokenCount)

isIgnoreLiterals

public boolean isIgnoreLiterals()

If true, CPD ignores literal value differences when evaluating a duplicate block. This means that foo=42; and foo=43; will be seen as equivalent. Default is false.

Returns:

True if differences in literals should be ignored, false if they should count.

setIgnoreLiterals

public void setIgnoreLiterals(boolean pIgnoreLiterals)

isIgnoreIdentifiers

public boolean isIgnoreIdentifiers()

If true, differences in identifiers (like variable names or methods names) will be ignored in the same way as literals in isIgnoreLiterals(). Default is false.

Returns:

True if differences in identifiers should be ignored, false if they should count.

setIgnoreIdentifiers

public void setIgnoreIdentifiers(boolean pIgnoreIdentifiers)

isIgnoreAnnotations

public boolean isIgnoreAnnotations()

If true, annotations will be ignored. This property can be useful when analyzing code based on certain frameworks where annotations become very repetitive. Default is false.

Returns:

True if annotations should be ignored, false if they should count.

setIgnoreAnnotations

public void setIgnoreAnnotations(boolean pIgnoreAnnotations)

isIgnoreUsings

public boolean isIgnoreUsings()

If true, using directives in C# will be ignored when comparing text. Default is false.

Returns:

True if using directives should be ignored, false if they should count.

setIgnoreUsings

public void setIgnoreUsings(boolean pIgnoreUsings)

isSkipDuplicateFiles

public boolean isSkipDuplicateFiles()

If true, CPD will ignore multiple copies of files with the same name and length. Default is false.

Returns:

True if duplicate files should be skipped, false if not.

setSkipDuplicateFiles

public void setSkipDuplicateFiles(boolean pSkipDuplicateFiles)

isSkipLexicalErrors

public boolean isSkipLexicalErrors()

If true, CPD will skip files which can't be tokenized due to invalid characters instead of aborting the analysis. Default is false.

Returns:

True if files with lexical errors should be skipped, false if not.

setSkipLexicalErrors

public void setSkipLexicalErrors(boolean pSkipLexicalErrors)

isSkipBlocks

public boolean isSkipBlocks()

If true, skipping of blocks is enabled with the patterns specified in the skipBlocksPattern property. Default is false.

Returns:

True if blocks matching skipBlocksPattern should be skipped, false if not.

setSkipBlocks

public void setSkipBlocks(boolean pSkipBlocks)

getSkipBlocksPattern

public java.lang.String getSkipBlocksPattern()

Specifies the pattern to find the blocks to skip when skipBlocks is true. The string value contains two parts, separated by a vertical line ('|'). The first part is the start pattern, the second part is the end pattern. The default value is "#if 0|#endif".

Returns:

The skip blocks pattern.

setSkipBlocksPattern

public void setSkipBlocksPattern(java.lang.String pSkipBlocksPattern)