Package com.jalios.jcms.tools

Class CheckerContext

java.lang.Object

com.jalios.jcms.tools.CheckerContext

public class CheckerContext
extends java.lang.Object

Stores common context for an AbstractChecker.

Since:

jcms-9.0.2

Author:

Sylvain Devaux

Constructor Summary

Constructors

Constructor	Description
CheckerContext(java.io.File webappDir, LangProperties properties, LangProperties langProperties)

Method Summary

Modifier and Type	Method	Description
LangProperties	getLangProperties()
LangProperties	getProperties()
java.io.File	getWebappDir()
boolean	isIgnored(java.lang.String propertyPrefix, CheckedFile file)	Allows to exclude some files, or directories, given the property that represent a particular test method.
boolean	isIgnored(java.lang.String propertyPrefix, CheckedFile file, java.util.Collection<java.lang.String> defaultIgnoredList)	Allows to exclude some files, or directories, given the property that represent a particular test method.

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckerContext

public CheckerContext(java.io.File webappDir,
                      LangProperties properties,
                      LangProperties langProperties)

Method Detail

getLangProperties

public LangProperties getLangProperties()

Returns:

the langProperties

getProperties

public LangProperties getProperties()

Returns:

the properties

getWebappDir

public java.io.File getWebappDir()

Returns:

the webappDir

isIgnored

public boolean isIgnored(java.lang.String propertyPrefix,
                         CheckedFile file)
                  throws java.io.IOException

Allows to exclude some files, or directories, given the property that represent a particular test method.

Parameters:

propertyPrefix - the prefix of the property to ignore a custom rule.

file - the file being tested

Returns:

true if given File

Throws:

java.io.IOException - ...

isIgnored

public boolean isIgnored(java.lang.String propertyPrefix,
                         CheckedFile file,
                         java.util.Collection<java.lang.String> defaultIgnoredList)

Allows to exclude some files, or directories, given the property that represent a particular test method.

Parameters:

propertyPrefix - the prefix of the property to ignore a custom rule.

file - the file being tested

defaultIgnoredList - an optional "hardcoded" ignore list. File will be ignored if its relative path is contained.

Returns:

true if given File