com.salesforce.omakase.util

Class Equivalents.RuleBase<N extends Named>

java.lang.Object

com.salesforce.omakase.util.Equivalents.RuleBase<N>

All Implemented Interfaces:

Equivalents.EquivalentWalker<Rule,N>

Enclosing class:

Equivalents

public abstract static class Equivalents.RuleBase<N extends Named>
extends Object
implements Equivalents.EquivalentWalker<Rule,N>

base for walkers that group Rules together

Constructor Summary

Constructors

Constructor and Description
RuleBase()

Method Summary

Modifier and Type	Method and Description
Rule	next(Rule peer) Gets the next unit, or null if none.
Rule	previous(Rule peer) Gets the previous unit, or null if none.
boolean	walkAll() Specifies whether we should walk all peers, or stop when a peer does not match.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.salesforce.omakase.util.Equivalents.EquivalentWalker

locate

Constructor Detail

RuleBase

public RuleBase()

Method Detail

previous

public Rule previous(Rule peer)

Description copied from interface: Equivalents.EquivalentWalker

Gets the previous unit, or null if none.

Specified by:

previous in interface Equivalents.EquivalentWalker<Rule,N extends Named>

Parameters:

peer - Find the unit previous to this one.

Returns:

The previous unit, or null if none.

next

public Rule next(Rule peer)

Description copied from interface: Equivalents.EquivalentWalker

Gets the next unit, or null if none.

Specified by:

next in interface Equivalents.EquivalentWalker<Rule,N extends Named>

Parameters:

peer - Find the unit after this one.

Returns:

The next unit, or null if none.

walkAll

public boolean walkAll()

Description copied from interface: Equivalents.EquivalentWalker

Specifies whether we should walk all peers, or stop when a peer does not match.

In other words, return true to evaluate all peers, even when null is returned from Equivalents.EquivalentWalker.locate(Object, Named), and return false to stop walking (in that direction) once Equivalents.EquivalentWalker.locate(Object, Named) returns null.

Specified by:

walkAll in interface Equivalents.EquivalentWalker<Rule,N extends Named>

Returns:

Whether all peers should be walked, or if we should stop walking a direction once a peer does not match.