Package org.apache.maven.enforcer.rules.files

Class RequireFilesExist

java.lang.Object

org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase

org.apache.maven.enforcer.rule.api.AbstractEnforcerRule

org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule

org.apache.maven.enforcer.rules.files.AbstractRequireFiles

org.apache.maven.enforcer.rules.files.RequireFilesExist

All Implemented Interfaces:

EnforcerRuleBase

@Named("requireFilesExist")
public final class RequireFilesExist
extends AbstractRequireFiles

The Class RequireFilesExist.

Constructor Summary

Constructors

Constructor	Description
RequireFilesExist()

Method Summary

Modifier and Type	Method	Description
(package private) boolean	checkFile(File file)	Check one file.
(package private) String	getErrorMsg()	Gets the error msg.
private boolean	osIndependentNameMatch(File file)	OSes like Windows are case-insensitive, so this method will compare the file path with the actual path.

Methods inherited from class org.apache.maven.enforcer.rules.files.AbstractRequireFiles

execute, getCacheId, getFiles, setAllowNulls, setFilesList, setSatisfyAny, toString

Methods inherited from class org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule

formatLocation, getMessage, setMessage

Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule

getLevel, getRuleName

Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase

getLog, setLog

Methods inherited from class java.lang.Object

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

Constructor Details

RequireFilesExist

public RequireFilesExist()

Method Details

checkFile

boolean checkFile(File file)

Description copied from class: AbstractRequireFiles

Check one file.

Specified by:

checkFile in class AbstractRequireFiles

Parameters:

file - the file

Returns:

true if successful

getErrorMsg

String getErrorMsg()

Description copied from class: AbstractRequireFiles

Gets the error msg.

Specified by:

getErrorMsg in class AbstractRequireFiles

Returns:

the error msg

osIndependentNameMatch

private boolean osIndependentNameMatch(File file)

OSes like Windows are case-insensitive, so this method will compare the file path with the actual path. A simple File.exists() is not enough for such OS.

Parameters:

file - the file to verify