Overview | Package | Class | Deprecated | Index | Help
| Groovy Documentation
| FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | METHOD | DETAIL: FIELD | METHOD

## org.gradle.api
[Java] Interface Rule

    public interface Rule

A `Rule` represents some action to perform when an unknown domain object is referenced. The rule can use the domain object name to add an implicit domain object.

Authors:
  Hans Dockter

Method Summary
`void` | `apply(java.lang.String domainObjectName)` Applies this rule for the given unknown domain object.
`java.lang.String` | `getDescription()` Returns the description of the rule.

Method Detail

### apply

    public void apply(java.lang.String domainObjectName)

  Applies this rule for the given unknown domain object. The rule can choose to ignore this name, or add a domain object with the given name.
  Parameters:
    `domainObjectName` - The name of the unknown domain object.

### getDescription

    public java.lang.String getDescription()

  Returns the description of the rule. This is used for reporting purposes.
  Returns:
    the description. should not return null.

Groovy Documentation