tom.library.sl
Class Fail

java.lang.Object
  tom.library.sl.AbstractStrategy
      tom.library.sl.Fail

All Implemented Interfaces:

Strategy, Visitable

public class Fail
extends AbstractStrategy

x.accept(Fail) always raises a VisitFailure exception.

Basic visitor combinator without arguments, that always fails.

Test case documentation: FailTest

Field Summary

Fields inherited from class tom.library.sl.AbstractStrategy

environment, visitors

Constructor Summary

Fail()
Construct Fail combinator with empty failure message.

Fail(java.lang.String message)
Construct Fail combinator with a failure message to be passed to the VisitFailure that it throws.

Method Summary

int	visit() Visits the current subject (found in the environment) and place its result in the environment.
Visitable	visitLight(Visitable any) Visits the subject any in a light way (without environment)

Methods inherited from class tom.library.sl.AbstractStrategy

accept, getChildAt, getChildCount, getChildren, getEnvironment, getRoot, getSubject, init, init, initSubterm, initSubterm, initSubterm, initSubterm, initSubterm, setChildAt, setChildren, setEnvironment, setRoot, setSubject, visit, visit

Methods inherited from class java.lang.Object

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

Constructor Detail

Fail

public Fail()

Construct Fail combinator with empty failure message.

Fail

public Fail(java.lang.String message)

Construct Fail combinator with a failure message to be passed to the VisitFailure that it throws.

Method Detail

visitLight

public Visitable visitLight(Visitable any)
                     throws VisitFailure

Description copied from interface: Strategy

Visits the subject any in a light way (without environment)

Parameters:

any - the subject to visit.

Throws:

VisitFailure - in case of failure.

visit

public int visit()

Description copied from interface: Strategy

Visits the current subject (found in the environment) and place its result in the environment. Sets the environment flag to Environment.FAILURE in case of failure