com.puppycrawl.tools.checkstyle.checks

Class AbstractFormatCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck

All Implemented Interfaces:

Configurable, Contextualizable

Direct Known Subclasses:

AbstractClassNameCheck, AbstractNameCheck, IllegalTokenTextCheck, IllegalTypeCheck, MutableExceptionCheck, PackageNameCheck, RegexpCheck, ReturnCountCheck, SuppressWarningsCheck, TrailingCommentCheck

public abstract class AbstractFormatCheck
extends Check

Abstract class for checks that verify strings using a regular expression. It provides support for setting the regular expression using the property name format.

Version:

1.0

Author:

Oliver Burn

Constructor Summary

Constructors

Constructor and Description
AbstractFormatCheck(String defaultFormat) Creates a new AbstractFormatCheck instance.
AbstractFormatCheck(String defaultFormat, int compileFlags) Creates a new AbstractFormatCheck instance.

Method Summary

Methods

Modifier and Type	Method and Description
String	getFormat()
Pattern	getRegexp()
void	setCompileFlags(int compileFlags) Set the compile flags for the regular expression.
void	setFormat(String format) Set the format to the specified regular expression.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getDefaultTokens, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFormatCheck

public AbstractFormatCheck(String defaultFormat)
                    throws org.apache.commons.beanutils.ConversionException

Creates a new AbstractFormatCheck instance. Defaults the compile flag to 0 (the default).

Parameters:

defaultFormat - default format

Throws:

org.apache.commons.beanutils.ConversionException - unable to parse defaultFormat

AbstractFormatCheck

public AbstractFormatCheck(String defaultFormat,
                   int compileFlags)
                    throws org.apache.commons.beanutils.ConversionException

Creates a new AbstractFormatCheck instance.

Parameters:

defaultFormat - default format

compileFlags - the Pattern flags to compile the regexp with. See Pattern.compile(java.lang.String, int)

Throws:

org.apache.commons.beanutils.ConversionException - unable to parse defaultFormat

Method Detail

setFormat

public final void setFormat(String format)
                     throws org.apache.commons.beanutils.ConversionException

Set the format to the specified regular expression.

Parameters:

format - a String value

Throws:

org.apache.commons.beanutils.ConversionException - unable to parse format

setCompileFlags

public final void setCompileFlags(int compileFlags)

Set the compile flags for the regular expression.

Parameters:

compileFlags - the compile flags to use.

getRegexp

public final Pattern getRegexp()

Returns:

the regexp to match against

getFormat

public final String getFormat()

Returns:

the regexp format