Package org.apache.maven.enforcer.rules.checksum

Class RequireTextFileChecksum

java.lang.Object

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

org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule

org.apache.maven.enforcer.rules.checksum.RequireFileChecksum

org.apache.maven.enforcer.rules.checksum.RequireTextFileChecksum

All Implemented Interfaces:

EnforcerRuleBase

@Named("requireTextFileChecksum")
public final class RequireTextFileChecksum
extends RequireFileChecksum

Rule to validate a text file to match the specified checksum.

Author:

Konrad Windszus

See Also:

• RequireFileChecksum

Constructor Summary

Constructors

Constructor	Description
RequireTextFileChecksum(org.apache.maven.project.MavenProject project)

Method Summary

Modifier and Type	Method	Description
protected String	calculateChecksum()
void	execute()	This is the interface into the rule.
Charset	getEncoding()
EnforcerLogger	getLog()	Provide an EnforcerLogger instance for Rule
void	setEncoding(String encoding)
void	setLog(EnforcerLogger log)	Used by EnforcerMojo to inject logger instance
void	setNormalizeLineSeparatorTo(org.apache.maven.enforcer.rules.checksum.NormalizeLineSeparatorReader.LineSeparator normalizeLineSeparatorTo)
String	toString()

Methods inherited from class org.apache.maven.enforcer.rules.checksum.RequireFileChecksum

calculateChecksum, getChecksum, getFile, getNonexistentFileMessage, getType, setChecksum, setFile, setNonexistentFileMessage, setType

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

formatLocation, getMessage, setMessage

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

getCacheId, getLevel

Methods inherited from class java.lang.Object

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

Constructor Details

RequireTextFileChecksum

@Inject
public RequireTextFileChecksum(org.apache.maven.project.MavenProject project)

Method Details

setNormalizeLineSeparatorTo

public void setNormalizeLineSeparatorTo(org.apache.maven.enforcer.rules.checksum.NormalizeLineSeparatorReader.LineSeparator normalizeLineSeparatorTo)

setEncoding

public void setEncoding(String encoding)

getEncoding

public Charset getEncoding()

execute

public void execute()
             throws EnforcerRuleException

Description copied from class: AbstractEnforcerRule

This is the interface into the rule. This method should throw an exception containing a reason message if the rule fails the check. The plugin will then decide based on the fail flag and rule level if it should stop or just log the message as a warning.

Overrides:

execute in class RequireFileChecksum

Throws:

EnforcerRuleException - the enforcer rule exception

EnforcerRuleError - in order to brake a build immediately

calculateChecksum

protected String calculateChecksum()
                            throws EnforcerRuleException

Overrides:

calculateChecksum in class RequireFileChecksum

Throws:

EnforcerRuleException

toString

public String toString()

Overrides:

toString in class RequireFileChecksum

setLog

public void setLog(EnforcerLogger log)

Used by EnforcerMojo to inject logger instance

Specified by:

setLog in interface EnforcerRuleBase

Parameters:

log - an EnforcerLogger instance

getLog

public EnforcerLogger getLog()

Provide an EnforcerLogger instance for Rule

NOTICE A logger is not available in constructors.

Returns:

an EnforcerLogger instance