RequireEncoding (Extra Enforcer Rules 1.12.1 API)

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:

mikedon/encoding-enforcer, ericbn/encoding-enforcer

Constructor Summary

Constructors
Constructor Description

RequireEncoding(org.apache.maven.project.MavenProject project)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`execute()`
`String`	`getEncoding()`
`protected String`	`getEncoding(File file)`
`String`	`getExcludes()`
`String`	`getIncludes()`
`org.apache.maven.enforcer.rule.api.EnforcerLogger`	`getLog()`
`boolean`	`isUseDefaultExcludes()`
`void`	`setEncoding(String encoding)`
`void`	`setExcludes(String excludes)`
`void`	`setIncludes(String includes)`
`void`	`setLog(org.apache.maven.enforcer.rule.api.EnforcerLogger arg0)`
`void`	`setUseDefaultExcludes(boolean useDefaultExcludes)`

Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
getCacheId, getLevel, getRuleName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RequireEncoding

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

Method Detail

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()