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

Class PropertyUsageRule

java.lang.Object

com.github.mikkoi.maven.plugins.enforcer.rule.propertyusage.PropertyUsageRule

All Implemented Interfaces:

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

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

Verifies for usage of properties mentioned in .properties files.

Constructor Summary

Constructors

Constructor and Description
PropertyUsageRule()

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.
Collection<String>	getDefinitions()
Map<String,Set<PropertyDefinition>>	getPropertiesDefined()
Map<String,Integer>	getPropertiesDefinedMoreThanOnce()
Set<com.github.mikkoi.maven.plugins.enforcer.rule.propertyusage.UsageFiles.UsageLocation>	getPropertiesNotDefined()
Set<String>	getPropertiesNotUsed() Getters for results, used for testing.
String	getReplaceInTemplateWithPropertyName()
Collection<String>	getTemplates()
Collection<String>	getUsages()
boolean	isCacheable() This tells the system if the results are cacheable at all.
boolean	isDefinedPropertiesAreUsed()
boolean	isDefinitionsOnlyOnce()
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.
boolean	isUsedPropertiesAreDefined()
void	setDefinedPropertiesAreUsed(boolean definedPropertiesAreUsed)
void	setDefinitions(Collection<String> definitions) Setters for the parameters (these are not used by Maven Enforcer, used for testing).
void	setDefinitionsOnlyOnce(boolean definitionsOnlyOnce)
void	setReplaceInTemplateWithPropertyName(String replaceInTemplateWithPropertyName)
void	setTemplates(Collection<String> templates)
void	setUsages(Collection<String> usages)
void	setUsedPropertiesAreDefined(boolean usedPropertiesAreDefined)

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyUsageRule

public PropertyUsageRule()

Method Detail

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.

getPropertiesNotUsed

@Nonnull
public Set<String> getPropertiesNotUsed()

Getters for results, used for testing.

getPropertiesNotDefined

@Nonnull
public Set<com.github.mikkoi.maven.plugins.enforcer.rule.propertyusage.UsageFiles.UsageLocation> getPropertiesNotDefined()

getPropertiesDefinedMoreThanOnce

@Nonnull
public Map<String,Integer> getPropertiesDefinedMoreThanOnce()

getPropertiesDefined

@Nonnull
public Map<String,Set<PropertyDefinition>> getPropertiesDefined()

isDefinedPropertiesAreUsed

public boolean isDefinedPropertiesAreUsed()

setDefinedPropertiesAreUsed

public void setDefinedPropertiesAreUsed(boolean definedPropertiesAreUsed)

isUsedPropertiesAreDefined

public boolean isUsedPropertiesAreDefined()

setUsedPropertiesAreDefined

public void setUsedPropertiesAreDefined(boolean usedPropertiesAreDefined)

isDefinitionsOnlyOnce

public boolean isDefinitionsOnlyOnce()

setDefinitionsOnlyOnce

public void setDefinitionsOnlyOnce(boolean definitionsOnlyOnce)

getReplaceInTemplateWithPropertyName

@Nonnull
public String getReplaceInTemplateWithPropertyName()

setReplaceInTemplateWithPropertyName

public void setReplaceInTemplateWithPropertyName(@Nonnull
                                                 String replaceInTemplateWithPropertyName)

getDefinitions

@Nonnull
public Collection<String> getDefinitions()

setDefinitions

public void setDefinitions(@Nonnull
                           Collection<String> definitions)

Setters for the parameters (these are not used by Maven Enforcer, used for testing).

getTemplates

@Nonnull
public Collection<String> getTemplates()

setTemplates

public void setTemplates(@Nonnull
                         Collection<String> templates)

getUsages

@Nonnull
public Collection<String> getUsages()

setUsages

public void setUsages(@Nonnull
                      Collection<String> usages)