org.rvpf.processor.engine.rpn.operation

Class SimpleOperations

Object

Operations

SimpleOperations

Direct Known Subclasses:

BasicOperations, BigDecimalOperations, BigIntegerOperations, BigRationalOperations, BooleanOperations, ComplexOperations, ContainerOperations, DateTimeOperations, DoubleOperations, LongOperations, RationalOperations, SelectorOperations, StackOperations, StringOperations

public abstract class SimpleOperations
extends Operations

Simple operations.

Abstract class base to build a simple operations module.

Constructor Summary

Constructors

Constructor and Description
SimpleOperations()

Method Summary

Modifier and Type	Method and Description
abstract void	execute(Task task, SimpleOperation.Reference reference) Executes an operation code within the context of a task.
protected static void	fail() Fails silently.
protected static void	fail(Messages.Entry entry, Object... params) Fails with a message.
protected void	register(String name, Enum<?> code) Registers an operation without filter.
protected void	register(String name, Enum<?> code, Filter filter) Registers an operation.
protected void	register(String name, Enum<?> code, Optional<Filter> filter) Registers an operation.

Methods inherited from class Operations

getParams, getRegistrations, getThisLogger, setUp, setUp

Methods inherited from class Object

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

Constructor Detail

SimpleOperations

public SimpleOperations()

Method Detail

execute

public abstract void execute(@Nonnull
                             Task task,
                             @Nonnull
                             SimpleOperation.Reference reference)
                      throws Task.ExecuteException,
                             Stack.AccessException

Executes an operation code within the context of a task.

Must be implemented by each module.

Parameters:

task - Task executing the program.

reference - Reference to the operation.

Throws:

Task.ExecuteException - when appropriate.

Stack.AccessException - When raised by the stack.

fail

protected static void fail()
                    throws Task.ExecuteException

Fails silently.

Throws:

Task.ExecuteException - Always.

fail

protected static void fail(@Nonnull
                           Messages.Entry entry,
                           @Nonnull
                           Object... params)
                    throws Task.ExecuteException

Fails with a message.

Parameters:

entry - The message format.

params - The message parameters.

Throws:

Task.ExecuteException - Always.

register

protected final void register(@Nonnull
                              String name,
                              @Nonnull
                              Enum<?> code)
                       throws Operation.OverloadException

Registers an operation without filter.

Parameters:

name - The operation name.

code - The operation code.

Throws:

Operation.OverloadException - From Operation.register(java.util.Map<java.lang.String, org.rvpf.processor.engine.rpn.operation.Operation>).

register

protected final void register(@Nonnull
                              String name,
                              @Nonnull
                              Enum<?> code,
                              @Nonnull
                              Filter filter)
                       throws Operation.OverloadException

Registers an operation.

Parameters:

name - The operation name.

code - The operation code.

filter - The operation overload filter.

Throws:

Operation.OverloadException - From Operation.register(java.util.Map<java.lang.String, org.rvpf.processor.engine.rpn.operation.Operation>).

register

protected final void register(@Nonnull
                              String name,
                              @Nonnull
                              Enum<?> code,
                              @Nonnull
                              Optional<Filter> filter)
                       throws Operation.OverloadException

Registers an operation.

Parameters:

name - The operation name.

code - The operation code.

filter - The optional operation overload filter.

Throws:

Operation.OverloadException - From Operation.register(java.util.Map<java.lang.String, org.rvpf.processor.engine.rpn.operation.Operation>).