java.lang.Object
- software.amazon.smithy.rulesengine.language.syntax.rule.Rule

All Implemented Interfaces:

FromSourceLocation, ToNode, TypeCheck

Direct Known Subclasses:

EndpointRule, ErrorRule, TreeRule
```
public abstract class Rule
extends java.lang.Object
implements TypeCheck, ToNode, FromSourceLocation
```
The core functionality of a rule-set rule.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Rule.Builder
A builder used to create a Rule class.

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`DOCUMENTATION`
`static java.lang.String`	`ENDPOINT`
`static java.lang.String`	`ERROR`
`static java.lang.String`	`RULES`
`static java.lang.String`	`TREE`
`static java.lang.String`	`TYPE`

Constructor Summary

Constructors
Modifier Constructor Description

protected Rule(Rule.Builder builder)

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract <T> T`	`accept(RuleValueVisitor<T> visitor)`	Invoke the `RuleValueVisitor` functions for this Rule.
`static Rule.Builder`	`builder()`	Builder to create a `Rule` instance.
`static Rule.Builder`	`builder(FromSourceLocation sourceLocation)`	Builder to create a `Rule` instance.
`boolean`	`equals(java.lang.Object o)`
`static Rule`	`fromNode(Node node)`	Creates a `Rule` instance from the given Node information.
`java.util.List<Condition>`	`getConditions()`	Gets the conditions required to satisfy this rule.
`java.util.Optional<java.lang.String>`	`getDocumentation()`	Gets the documentation value.
`SourceLocation`	`getSourceLocation()`	Gets the source location of a value.
`int`	`hashCode()`
`Node`	`toNode()`	Converts a value to a `Node`.
`java.lang.String`	`toString()`
`Type`	`typeCheck(Scope<Type> scope)`	Checks whether the given types within a scope satisfy the constraints.
`protected abstract Type`	`typecheckValue(Scope<Type> scope)`

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

- Field Detail
  - DOCUMENTATION
```
public static final java.lang.String DOCUMENTATION
```
    See Also:
    
    Constant Field Values
  - ENDPOINT
```
public static final java.lang.String ENDPOINT
```
    See Also:
    
    Constant Field Values
  - ERROR
```
public static final java.lang.String ERROR
```
    See Also:
    
    Constant Field Values
  - TREE
```
public static final java.lang.String TREE
```
    See Also:
    
    Constant Field Values
  - RULES
```
public static final java.lang.String RULES
```
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final java.lang.String TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Rule
```
protected Rule(Rule.Builder builder)
```
- Method Detail
  - builder
```
public static Rule.Builder builder()
```
    Builder to create a Rule instance.
    
    Returns:
    
    returns a new Builder.
  - builder
```
public static Rule.Builder builder(FromSourceLocation sourceLocation)
```
    Builder to create a Rule instance.
    
    Parameters:
    
    sourceLocation - the source of the rule.
    
    Returns:
    
    returns a new Builder.
  - fromNode
```
public static Rule fromNode(Node node)
```
    Creates a Rule instance from the given Node information.
    
    Parameters:
    
    node - the node to deserialize.
    
    Returns:
    
    the created Rule.
  - getSourceLocation
```
public SourceLocation getSourceLocation()
```
    Description copied from interface: FromSourceLocation
    
    Gets the source location of a value.
    
    Specified by:
    
    getSourceLocation in interface FromSourceLocation
    
    Returns:
    
    Returns the source location of the value.
  - getConditions
```
public java.util.List<Condition> getConditions()
```
    Gets the conditions required to satisfy this rule.
    
    Returns:
    
    the list of conditions.
  - getDocumentation
```
public java.util.Optional<java.lang.String> getDocumentation()
```
    Gets the documentation value.
    
    Returns:
    
    returns the optional documentation value.
  - accept
```
public abstract <T> T accept(RuleValueVisitor<T> visitor)
```
    Invoke the RuleValueVisitor functions for this Rule.
    
    Type Parameters:
    
    T - the visitor return type.
    
    Parameters:
    
    visitor - the visitor to be invoked.
    
    Returns:
    
    the return value of the visitor.
  - typecheckValue
```
protected abstract Type typecheckValue(Scope<Type> scope)
```
  - typeCheck
```
public Type typeCheck(Scope<Type> scope)
```
    Description copied from interface: TypeCheck
    
    Checks whether the given types within a scope satisfy the constraints.
    
    Specified by:
    
    typeCheck in interface TypeCheck
    
    Parameters:
    
    scope - the scope to evaluate.
    
    Returns:
    
    the type validated by the scope check.
  - toNode
```
public Node toNode()
```
    Description copied from interface: ToNode
    
    Converts a value to a Node.
    
    Specified by:
    
    toNode in interface ToNode
    
    Returns:
    
    Returns the creates Node.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Rule

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DOCUMENTATION

ENDPOINT

ERROR

TREE

RULES

TYPE

Constructor Detail

Rule

Method Detail

builder

builder

fromNode

getSourceLocation

getConditions

getDocumentation

accept

typecheckValue

typeCheck

toNode

equals

hashCode

toString