RequireProperty

java.lang.Object

org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

org.apache.maven.plugins.enforcer.AbstractPropertyEnforcerRule

org.apache.maven.plugins.enforcer.RequireProperty

All Implemented Interfaces:: EnforcerRule, EnforcerRule2

public class RequireProperty extends AbstractPropertyEnforcerRule

This rule checks that certain properties are set.

Field Summary

Fields

Modifier and Type

Field

Description

private String

property

Specify the required property.
Constructor Summary

Constructors

Constructor

Description

RequireProperty()
Method Summary

Modifier and Type

Method

Description

String

getName()

How the property that is being evaluated is called

String

getPropertyName()

The name of the property currently being evaluated, this is used for default message purposes only

protected String

resolveValue()

Object

resolveValue(EnforcerRuleHelper helper)

Resolves the property value

final void

setProperty(String property)

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractPropertyEnforcerRule
execute, getRegex, getRegexMessage, setRegex, setRegexMessage

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
getCacheId, isCacheable, isResultValid

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
getLevel, getMessage, setLevel, setMessage

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

Field Details
- property
  
  private String property
  
  Specify the required property.
Constructor Details
- RequireProperty
  
  public RequireProperty()
Method Details
- setProperty
  
  public final void setProperty(String property)
- resolveValue
  
  public Object resolveValue(EnforcerRuleHelper helper) throws EnforcerRuleException
  
  Description copied from class: AbstractPropertyEnforcerRule
  
  Resolves the property value
  
  Specified by:
  
  resolveValue in class AbstractPropertyEnforcerRule
  
  Throws:
  
  EnforcerRuleException
- resolveValue
  
  protected String resolveValue()
- getPropertyName
  
  public String getPropertyName()
  
  Description copied from class: AbstractPropertyEnforcerRule
  
  The name of the property currently being evaluated, this is used for default message purposes only
  
  Specified by:
  
  getPropertyName in class AbstractPropertyEnforcerRule
  
  Returns:
  
  the name of the property
- getName
  
  public String getName()
  
  Description copied from class: AbstractPropertyEnforcerRule
  
  How the property that is being evaluated is called
  
  Specified by:
  
  getName in class AbstractPropertyEnforcerRule
  
  Returns:
  
  kind of property