EnumBranch (BandM metatools API doc)

java.lang.Object
- eu.bandm.tools.paisley.Pattern<A>
- - eu.bandm.tools.paisley.EnumBranch<A,E>

All Implemented Interfaces:

Serializable, Cloneable
```
public class EnumBranch<A,E extends Enum<E>>
extends Pattern<A>
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

EnumBranch(Class<E> cls)

EnumBranch(EnumMap<E,? extends Pattern<? super A>> map)

EnumBranch(Map<E,? extends Pattern<? super A>> map)

Constructors
Constructor and Description
`EnumBranch(Class<E> cls)`
`EnumBranch(EnumMap<E,? extends Pattern<? super A>> map)`
`EnumBranch(Map<E,? extends Pattern<? super A>> map)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`binds(Variable<?> v)` Checks whether a variable is bound by this pattern.
`void`	`clear(boolean recursively)` Disposes of all internal state related to results and nondeterminism.
`Pattern<A>`	`clone()` Makes a matching-state copy if this pattern.
`void`	`cut(boolean recursively)` Disposes of all internal state related to nondeterminism.
`E`	`getKey()`
`boolean`	`isDeterministic()` Checks whether this pattern is deterministic.
`boolean`	`match(A target)` Attempts to match this pattern against a given object.
`boolean`	`matchAgain()` Attempts to re-match this pattern against a previously matched object.
`boolean`	`preserves(Variable<?> v)` Checks whether a variable is preserved by this pattern, unconditionally.
`boolean`	`preserves(Variable<?> v, boolean success)` Checks whether a variable is preserved by this pattern, conditionally on success or failure.
`EnumBranch<A,E>`	`put(E key, Pattern<? super A> pattern)`

Methods inherited from class eu.bandm.tools.paisley.Pattern
all, all, all, all, all, and, andThen, andThen, any, any, aside, both, clear, compareTo, compile, compileClear, compileClear, compileCut, compileCut, compileIsDeterministic, compileMatch, compileMatchAgain, compileSubPattern, compileThis, compileUpTo, cut, DEBUG, either, enPassant, eq, eqNull, equal, filter, flatten, forInstancesOf, limit, main, matchOnce, matchVar, narrow, neq, neqNull, newAll, noMatch, none, or, orElse, orElse, repeat, some, some, some, some, someMatch, startCompile, test, transform, uniquely, variable, variable

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

- Constructor Detail
  - EnumBranch
```
public EnumBranch(EnumMap<E,? extends Pattern<? super A>> map)
```
  - EnumBranch
```
public EnumBranch(Map<E,? extends Pattern<? super A>> map)
```
  - EnumBranch
```
public EnumBranch(Class<E> cls)
```
- Method Detail
  - put
```
public EnumBranch<A,E> put(E key,
                           Pattern<? super A> pattern)
```
  - getKey
```
public E getKey()
```
  - match
```
public boolean match(A target)
```
    Description copied from class: Pattern
    
    Attempts to match this pattern against a given object. If the class of this pattern imposes a specific order on matches, the first one is chosen.
    
    Specified by:
    
    match in class Pattern<A>
    
    Parameters:
    
    target - the object to match against
    
    Returns:
    
    true if the matching is successful, false if it fails. Which Variables are bound by a successful or failed match depends.
    
    See Also:
    
    Pattern.binds(Variable), Pattern.preserves(Variable, boolean)
  - matchAgain
```
public boolean matchAgain()
```
    Description copied from class: Pattern
    
    Attempts to re-match this pattern against a previously matched object. If the class of this pattern imposes a specific order on matches, they are chosen in that order, beginning with the second one. The behaviour of this method is unspecified if the last matching attempt of this pattern has not been successful.
    Patterns classes that do not override this method are deterministic. Pattern classes that overwrite this method to provide additional matches should also override Pattern.isDeterministic().
    
    Overrides:
    
    matchAgain in class Pattern<A>
    
    Returns:
    
    true if the matching is successful, false if it fails. Which Variables are bound by a successful match depends. The default implementation always returns false.
    
    See Also:
    
    Pattern.binds(Variable), Pattern.preserves(Variable, boolean)
  - cut
```
public void cut(boolean recursively)
```
    Description copied from class: Pattern
    
    Disposes of all internal state related to nondeterminism.
    The default implementation does nothing. Subclasses that override this method should also override Pattern.clear(boolean) and ensure that it implies the effect of cut(false).
    
    Overrides:
    
    cut in class Pattern<A>
    
    Parameters:
    
    recursively - true if all subpatterns should be deactivated, false otherwise.
  - clear
```
public void clear(boolean recursively)
```
    Description copied from class: Pattern
    
    Disposes of all internal state related to results and nondeterminism.
    The default implementation does nothing.
    
    Overrides:
    
    clear in class Pattern<A>
    
    Parameters:
    
    recursively - true if all subpatterns should be deactivated, false otherwise.
  - binds
```
public boolean binds(Variable<?> v)
```
    Description copied from class: Pattern
    
    Checks whether a variable is bound by this pattern.
    The default implementation returns false.
    
    Overrides:
    
    binds in class Pattern<A>
    
    Parameters:
    
    v - a pattern variable
    
    Returns:
    
    true if the variable is guaranteed to have a meaningful value when this pattern is open, false otherwise.
  - preserves
```
public boolean preserves(Variable<?> v,
                         boolean success)
```
    Description copied from class: Pattern
    
    Checks whether a variable is preserved by this pattern, conditionally on success or failure.
    The default implementation returns false.
    
    Overrides:
    
    preserves in class Pattern<A>
    
    Parameters:
    
    v - a pattern variable
    
    success - specifies preservation on success or failure
    
    Returns:
    
    true if the variable value is guaranteed to be unaffected by a matching attempt with this pattern that returns a value equal to success.
  - preserves
```
public boolean preserves(Variable<?> v)
```
    Description copied from class: Pattern
    
    Checks whether a variable is preserved by this pattern, unconditionally.
    The default implementation returns false.
    
    Overrides:
    
    preserves in class Pattern<A>
    
    Parameters:
    
    v - a pattern variable
    
    Returns:
    
    true if the variable value is guaranteed to be unaffected by any matching attempt with this pattern.
  - isDeterministic
```
public boolean isDeterministic()
```
    Description copied from class: Pattern
    
    Checks whether this pattern is deterministic.
    The default implementation returns true.
    
    Overrides:
    
    isDeterministic in class Pattern<A>
    
    Returns:
    
    true if this pattern is guaranteed to match any object at most once, false otherwise.
    
    See Also:
    
    Pattern.matchAgain()
  - clone
```
public Pattern<A> clone()
```
    Description copied from class: Pattern
    Makes a matching-state copy if this pattern.
    Subclasses must override this method if necessary to honour the following rules for all transitively reachable patterns:
    - Subpatterns that are instances of Variable must be shared. This implies that Variable.clone() must return this.
    - Fields that do not refer to subpatterns, but to matching state (changed by invocations of Pattern.match(A), Pattern.matchAgain(), Pattern.cut() or Pattern.clear()) must be duplicated. If matching state changes are effected by modification of other objects, these must be duplicated. In summary, matching operations on this pattern and its copy must not interfere, with the exception of variable bindings.
    - Fields neither referring to subpatterns nor to matching state may be either shared or duplicated. The usage of such fields in a modifiable way (such that the distinction is relevant) is strongly deprecated.
    - Patterns whose fields need not be duplicated need not be duplicated themselves, but may return this.
    Overrides:
    
    clone in class Pattern<A>

Class EnumBranch<A,E extends Enum<E>>

Constructor Summary

Method Summary

Methods inherited from class eu.bandm.tools.paisley.Pattern

Methods inherited from class java.lang.Object

Constructor Detail

EnumBranch

EnumBranch

EnumBranch

Method Detail

put

getKey

match

matchAgain

cut

clear

binds

preserves

preserves

isDeterministic

clone