Package org.codehaus.mojo.extraenforcer.encoding

Class RequireEncoding

java.lang.Object
org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
org.codehaus.mojo.extraenforcer.encoding.RequireEncoding
All Implemented Interfaces:
org.apache.maven.enforcer.rule.api.EnforcerRuleBase
@Named("requireEncoding") public class RequireEncoding extends org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
Checks file encodings to see if they match the project.build.sourceEncoding If file encoding can not be determined it is skipped.
See Also:

  • Field Details

    • ISO_8859_15

      private static final String ISO_8859_15
      See Also:

    • encoding

      private String encoding
      Validate files match this encoding. If not specified then default to ${project.build.sourceEncoding}.

    • includes

      private String includes
      Comma (or pipe) separated list of globs do include.

    • excludes

      private String excludes
      Comma (or pipe) separated list of globs do exclude.

    • useDefaultExcludes

      private boolean useDefaultExcludes
      Enables SCM files exclusions. Enabled by default.

    • failFast

      private boolean failFast
      Should the rule fail after the first error or should the errors be aggregated.

    • acceptAsciiSubset

      private boolean acceptAsciiSubset
      Should the rule accept US-ASCII as an subset of UTF-8 and ISO-8859-1/-15.

    • acceptIso8859Subset

      private boolean acceptIso8859Subset
      Should the rule accept ISO-8859-1 as a subset of ISO-8859-15.

    • project

      private final org.apache.maven.project.MavenProject project

  • Constructor Details

    • RequireEncoding

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

  • Method Details

    • execute

      public void execute() throws org.apache.maven.enforcer.rule.api.EnforcerRuleException
      Specified by:
      execute in class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
      Throws:
      org.apache.maven.enforcer.rule.api.EnforcerRuleException

    • getEncoding

      protected String getEncoding(File file) throws IOException
      Throws:
      IOException

    • getEncoding

      public String getEncoding()

    • setEncoding

      public void setEncoding(String encoding)

    • getIncludes

      public String getIncludes()

    • setIncludes

      public void setIncludes(String includes)

    • getExcludes

      public String getExcludes()

    • setExcludes

      public void setExcludes(String excludes)

    • isUseDefaultExcludes

      public boolean isUseDefaultExcludes()

    • setUseDefaultExcludes

      public void setUseDefaultExcludes(boolean useDefaultExcludes)

    • setLog

      public void setLog(org.apache.maven.enforcer.rule.api.EnforcerLogger arg0)
      Specified by:
      setLog in interface org.apache.maven.enforcer.rule.api.EnforcerRuleBase

    • getLog

      public org.apache.maven.enforcer.rule.api.EnforcerLogger getLog()