com.github.mikkoi.maven.plugins.enforcer.rule.charsetencoding

Class CharacterSetEncodingRule

java.lang.Object

com.github.mikkoi.maven.plugins.enforcer.rule.charsetencoding.CharacterSetEncodingRule

All Implemented Interfaces:

org.apache.maven.enforcer.rule.api.EnforcerRule

public final class CharacterSetEncodingRule
extends Object
implements org.apache.maven.enforcer.rule.api.EnforcerRule

Checks file encodings to see if they match the parameter or Maven property project.build.sourceEncoding. If file requireEncoding can not be determined it is skipped.

Constructor Summary

Constructors

Constructor and Description
CharacterSetEncodingRule()

Method Summary

Modifier and Type	Method and Description
void	execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
String	getCacheId() If your rule is cacheable, you must return a unique id when parameters or conditions change that would cause the result to be different.
String	getDirectory() Getters and setters for the parameters (these are filled by Maven).
String	getExcludeRegex()
Collection<com.github.mikkoi.maven.plugins.enforcer.rule.charsetencoding.FileResult>	getFaultyFiles() Get the faulty files list.
String	getIncludeRegex()
String	getRequireEncoding()
boolean	isCacheable() This tells the system if the results are cacheable at all.
boolean	isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule arg0) If the rule is cacheable and the same id is found in the cache, the stored results are passed to this method to allow double checking of the results.
void	setDirectory(String directory)
void	setExcludeRegex(String excludeRegex)
void	setIncludeRegex(String includeRegex)
void	setRequireEncoding(String requireEncoding)

Methods inherited from class java.lang.Object

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

Constructor Detail

CharacterSetEncodingRule

public CharacterSetEncodingRule()

Method Detail

getFaultyFiles

@Nonnull
public Collection<com.github.mikkoi.maven.plugins.enforcer.rule.charsetencoding.FileResult> getFaultyFiles()

Get the faulty files list.

execute

public void execute(@Nonnull
                    org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
             throws org.apache.maven.enforcer.rule.api.EnforcerRuleException

Specified by:

execute in interface org.apache.maven.enforcer.rule.api.EnforcerRule

Parameters:

helper - EnforcerRuleHelper

Throws:

org.apache.maven.enforcer.rule.api.EnforcerRuleException - Throws when error

getCacheId

@Nullable
public String getCacheId()

If your rule is cacheable, you must return a unique id when parameters or conditions change that would cause the result to be different. Multiple cached results are stored based on their id.

The easiest way to do this is to return a hash computed from the values of your parameters.

If your rule is not cacheable, then the result here is not important, you may return anything.

Specified by:

getCacheId in interface org.apache.maven.enforcer.rule.api.EnforcerRule

Returns:

Always false here.

isCacheable

public boolean isCacheable()

This tells the system if the results are cacheable at all. Keep in mind that during forked builds and other things, a given rule may be executed more than once for the same project. This means that even things that change from project to project may still be cacheable in certain instances.

Specified by:

isCacheable in interface org.apache.maven.enforcer.rule.api.EnforcerRule

Returns:

Always false here.

isResultValid

public boolean isResultValid(@Nullable
                             org.apache.maven.enforcer.rule.api.EnforcerRule arg0)

If the rule is cacheable and the same id is found in the cache, the stored results are passed to this method to allow double checking of the results. Most of the time this can be done by generating unique ids, but sometimes the results of objects returned by the helper need to be queried. You may for example, store certain objects in your rule and then query them later.

Specified by:

isResultValid in interface org.apache.maven.enforcer.rule.api.EnforcerRule

Parameters:

arg0 - EnforcerRule

Returns:

Always false here.

getDirectory

@Nullable
public String getDirectory()

Getters and setters for the parameters (these are filled by Maven).

setDirectory

public void setDirectory(@Nullable
                         String directory)

getIncludeRegex

@Nullable
public String getIncludeRegex()

setIncludeRegex

public void setIncludeRegex(@Nullable
                            String includeRegex)

getExcludeRegex

@Nullable
public String getExcludeRegex()

setExcludeRegex

public void setExcludeRegex(@Nullable
                            String excludeRegex)

getRequireEncoding

@Nullable
public String getRequireEncoding()

setRequireEncoding

public void setRequireEncoding(@Nullable
                               String requireEncoding)