org.apache.maven.plugin.enforcer
Class RequireProperty

java.lang.Object
  extended by org.apache.maven.plugin.enforcer.RequireProperty
All Implemented Interfaces:
org.apache.maven.shared.enforcer.rule.api.EnforcerRule

public class RequireProperty
extends java.lang.Object
implements org.apache.maven.shared.enforcer.rule.api.EnforcerRule

This rule checks that certain properties are set.

Author:
Paul Gier

Field Summary
 java.lang.String message
          Specify a warning message if the property is not set.
 java.lang.String property
          Specify the required property.
 java.lang.String regex
          Match the property value to a given regular expresssion.
 java.lang.String regexMessage
          Specify a warning message if the regular expression is not matched.
 
Constructor Summary
RequireProperty()
           
 
Method Summary
 void execute(org.apache.maven.shared.enforcer.rule.api.EnforcerRuleHelper helper)
          Execute the rule.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

property

public java.lang.String property
Specify the required property.


message

public java.lang.String message
Specify a warning message if the property is not set.


regex

public java.lang.String regex
Match the property value to a given regular expresssion. Defaults to null (any value is ok).


regexMessage

public java.lang.String regexMessage
Specify a warning message if the regular expression is not matched.

Constructor Detail

RequireProperty

public RequireProperty()
Method Detail

execute

public void execute(org.apache.maven.shared.enforcer.rule.api.EnforcerRuleHelper helper)
             throws org.apache.maven.shared.enforcer.rule.api.EnforcerRuleException
Execute the rule.

Specified by:
execute in interface org.apache.maven.shared.enforcer.rule.api.EnforcerRule
Throws:
org.apache.maven.shared.enforcer.rule.api.EnforcerRuleException


Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.