com.flyingspaniel.nava.utils

Class EmittingCallbackFn<IN,OUT>

java.lang.Object

com.flyingspaniel.nava.emit.Emitter

com.flyingspaniel.nava.utils.EmittingCallbackFn<IN,OUT>

All Implemented Interfaces:

Callback<IN,OUT>, Emit.IEmitter, Emit.IListener<IN>, Fn<IN,OUT>

Direct Known Subclasses:

EmittingCallbackFn.NOP, Request

public abstract class EmittingCallbackFn<IN,OUT>
extends Emitter
implements Callback<IN,OUT>, Fn<IN,OUT>, Emit.IListener<IN>

"Do It All" base class Subclasses must override callback(), and may want to override others

Since:

Copyright (c) 2013 by Morgan Conrad

Author:

Morgan Conrad

See Also:

This software is released under the MIT License

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmittingCallbackFn.NOP<IN>

Nested classes/interfaces inherited from interface com.flyingspaniel.nava.callback.Callback

Callback.ProducesMore<IN,OUT,MORE>, Callback.ProducesMultiple<IN,OUT>

Nested classes/interfaces inherited from interface com.flyingspaniel.nava.fp.Fn

Fn.AndN<IN,OUT>, Fn.Base<IN,OUT>, Fn.N<IN,OUT>, Fn.Pdouble, Fn.Pint

Field Summary

Fields

Modifier and Type	Field and Description
protected Callback	nextCallback

Fields inherited from class com.flyingspaniel.nava.emit.Emitter

allowDuplicates, idMap, maxListeners

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EmittingCallbackFn()

Method Summary

Methods

Modifier and Type	Method and Description
abstract OUT	callback(Exception ex, IN in, Object... more) The callback method
protected void	failFast(Exception ex, IN in, Object... more) failFast means handle any Exception immediately.
protected void	failSlow(Exception ex, IN in, Object... more) failSlow means we let the nextCallback, if any, handle the Exception
OUT	fn1(IN in) Apply the function to a single argument
OUT	fn2(IN in1, IN in2ignored) Apply the function to a two arguments
Callback	getNextCallback() Get the callback to follow this one.
void	handleEvent(IN arg0, Object... more) Receive and handle an "event", represented by arg0 and possibly more.
protected void	handleException(Exception ex, IN in, Object... more) Subclasses may want to override to log, etc...
void	setNextCallback(Callback nextCallback) Set the callback to follow this one.

Methods inherited from class com.flyingspaniel.nava.emit.Emitter

addListener, createListenerList, emit, emit, fireEvent, getListenerList, listenerCount, listeners, on, once, removeAllListeners, removeListener, setMaxListeners

Methods inherited from class java.lang.Object

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

Field Detail

nextCallback

protected Callback nextCallback

Constructor Detail

EmittingCallbackFn

protected EmittingCallbackFn()

Method Detail

callback

public abstract OUT callback(Exception ex,
           IN in,
           Object... more)
                      throws Exception

Description copied from interface: Callback

The callback method

Specified by:

callback in interface Callback<IN,OUT>

Parameters:

ex - null, or an Exception thrown from an earlier callback. You should test for this!

in - input data, probably coming from a previous callback

more - additional input data (rarely used)

Returns:

result of processing

Throws:

Exception

setNextCallback

public void setNextCallback(Callback nextCallback)

Description copied from interface: Callback

Set the callback to follow this one.

Specified by:

setNextCallback in interface Callback<IN,OUT>

Parameters:

nextCallback - null means end of the line

getNextCallback

public Callback getNextCallback()

Description copied from interface: Callback

Get the callback to follow this one.

Specified by:

getNextCallback in interface Callback<IN,OUT>

Returns:

null means end of the line

fn1

public OUT fn1(IN in)

Description copied from interface: Fn

Apply the function to a single argument

Specified by:

fn1 in interface Fn<IN,OUT>

Parameters:

in - input

Returns:

OUT

fn2

public OUT fn2(IN in1,
      IN in2ignored)

Description copied from interface: Fn

Apply the function to a two arguments

Specified by:

fn2 in interface Fn<IN,OUT>

Returns:

OUT

handleEvent

public void handleEvent(IN arg0,
               Object... more)

Description copied from interface: Emit.IListener

Receive and handle an "event", represented by arg0 and possibly more. The details of what gets sent depend on IEmitter.emit()

Specified by:

handleEvent in interface Emit.IListener<IN>

Parameters:

arg0 - hopefully of type

more - often empty

failFast

protected void failFast(Exception ex,
            IN in,
            Object... more)
                 throws Exception

failFast means handle any Exception immediately. By default (see handleException) we throw it

Throws:

Exception

failSlow

protected void failSlow(Exception ex,
            IN in,
            Object... more)
                 throws Exception

failSlow means we let the nextCallback, if any, handle the Exception

Throws:

Exception

handleException

protected void handleException(Exception ex,
                   IN in,
                   Object... more)
                        throws Exception

Subclasses may want to override to log, etc... (may be a good spot for D.I.)

Throws:

Exception