net.java.truevfs.comp.inst

Class Mediator<This extends Mediator<This>>

java.lang.Object

net.java.truevfs.comp.inst.Mediator<This>

Type Parameters:

This - the type of this mediator.

Direct Known Subclasses:

JmxMediator

@Immutable
public abstract class Mediator<This extends Mediator<This>>
extends Object

Implements the mediator role of the mediator pattern for instrumenting all objects which are used by the TrueVFS Kernel. When any of the instrumentation methods are called, implementations are given the choice to either return the given object as is or to decorate it with a colleague for instrumentation.

Implementations generally need to be thread-safe.

Author:

Christian Schlichtherle

Constructor Summary

Constructors

Constructor and Description
Mediator()

Method Summary

Modifier and Type	Method and Description
FsManager	instrument(FsManager subject) Instruments the given subject.
<B extends net.java.truecommons.cio.IoBuffer> net.java.truecommons.cio.InputSocket<B>	instrument(InstrumentingBuffer<This> context, net.java.truecommons.cio.InputSocket<B> subject) Instruments the given subject.
<B extends net.java.truecommons.cio.IoBuffer> net.java.truecommons.cio.OutputSocket<B>	instrument(InstrumentingBuffer<This> context, net.java.truecommons.cio.OutputSocket<B> subject) Instruments the given subject.
net.java.truecommons.cio.IoBuffer	instrument(InstrumentingBufferPool<This> context, net.java.truecommons.cio.IoBuffer subject) Instruments the given subject.
FsController	instrument(InstrumentingCompositeDriver<This> context, FsController subject) Instruments the given subject.
FsModel	instrument(InstrumentingCompositeDriver<This> context, FsModel subject) Instruments the given subject.
<E extends net.java.truecommons.cio.Entry> net.java.truecommons.cio.InputSocket<E>	instrument(InstrumentingController<This> context, net.java.truecommons.cio.InputSocket<E> subject) Instruments the given subject.
<E extends net.java.truecommons.cio.Entry> net.java.truecommons.cio.OutputSocket<E>	instrument(InstrumentingController<This> context, net.java.truecommons.cio.OutputSocket<E> subject) Instruments the given subject.
<E extends net.java.truecommons.cio.Entry> InputStream	instrument(InstrumentingInputSocket<This,E> context, InputStream subject) Instruments the given subject.
<E extends net.java.truecommons.cio.Entry> SeekableByteChannel	instrument(InstrumentingInputSocket<This,E> context, SeekableByteChannel subject) Instruments the given subject.
FsCompositeDriver	instrument(InstrumentingManager<This> context, FsCompositeDriver subject) Instruments the given subject.
FsController	instrument(InstrumentingManager<This> context, FsController subject) Instruments the given subject.
<E extends net.java.truecommons.cio.Entry> OutputStream	instrument(InstrumentingOutputSocket<This,E> context, OutputStream subject) Instruments the given subject.
<E extends net.java.truecommons.cio.Entry> SeekableByteChannel	instrument(InstrumentingOutputSocket<This,E> context, SeekableByteChannel subject) Instruments the given subject.
net.java.truecommons.cio.IoBufferPool	instrument(net.java.truecommons.cio.IoBufferPool subject) Instruments the given subject.

Methods inherited from class java.lang.Object

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

Constructor Detail

Mediator

public Mediator()

Method Detail

instrument

public FsManager instrument(FsManager subject)

Instruments the given subject.

Parameters:

subject - the subject of instrumentation.

Returns:

An instrumenting object or subject if the implementation does not want to instrument it.

instrument

public <B extends net.java.truecommons.cio.IoBuffer> net.java.truecommons.cio.InputSocket<B> instrument(InstrumentingBuffer<This> context,
                                                                                                        net.java.truecommons.cio.InputSocket<B> subject)

Instruments the given subject.

Type Parameters:

B - the type of the target entry for I/O operations.

Parameters:

context - the instrumenting object which called this method.

subject - the subject of instrumentation.

Returns:

An instrumenting object or subject if the implementation does not want to instrument it.

See Also:

instrument(InstrumentingBufferPool, IoBuffer)

instrument

public <B extends net.java.truecommons.cio.IoBuffer> net.java.truecommons.cio.OutputSocket<B> instrument(InstrumentingBuffer<This> context,
                                                                                                         net.java.truecommons.cio.OutputSocket<B> subject)

Instruments the given subject.

Type Parameters:

B - the type of the target entry for I/O operations.

Parameters:

context - the instrumenting object which called this method.

subject - the subject of instrumentation.

Returns:

An instrumenting object or subject if the implementation does not want to instrument it.

See Also:

instrument(InstrumentingBufferPool, IoBuffer)

instrument

public net.java.truecommons.cio.IoBuffer instrument(InstrumentingBufferPool<This> context,
                                                    net.java.truecommons.cio.IoBuffer subject)

Instruments the given subject.

Parameters:

context - the instrumenting object which called this method.

subject - the subject of instrumentation.

Returns:

An instrumenting object or subject if the implementation does not want to instrument it.

See Also:

instrument(IoBufferPool)

instrument

public FsController instrument(InstrumentingCompositeDriver<This> context,
                               FsController subject)

Instruments the given subject.

Parameters:

context - the instrumenting object which called this method.

subject - the subject of instrumentation.

Returns:

An instrumenting object or subject if the implementation does not want to instrument it.

See Also:

instrument(InstrumentingManager, FsCompositeDriver)

instrument

public FsModel instrument(InstrumentingCompositeDriver<This> context,
                          FsModel subject)

Instruments the given subject.

Parameters:

context - the instrumenting object which called this method.

subject - the subject of instrumentation.

Returns:

An instrumenting object or subject if the implementation does not want to instrument it.

See Also:

instrument(InstrumentingManager, FsCompositeDriver)

instrument

public <E extends net.java.truecommons.cio.Entry> net.java.truecommons.cio.InputSocket<E> instrument(InstrumentingController<This> context,
                                                                                                     net.java.truecommons.cio.InputSocket<E> subject)

Instruments the given subject.

Type Parameters:

E - the type of the target entry for I/O operations.

Parameters:

context - the instrumenting object which called this method.

subject - the subject of instrumentation.

Returns:

An instrumenting object or subject if the implementation does not want to instrument it.

See Also:

instrument(InstrumentingManager, FsController), instrument(InstrumentingCompositeDriver, FsController)

instrument

public <E extends net.java.truecommons.cio.Entry> net.java.truecommons.cio.OutputSocket<E> instrument(InstrumentingController<This> context,
                                                                                                      net.java.truecommons.cio.OutputSocket<E> subject)

Instruments the given subject.

Type Parameters:

E - the type of the target entry for I/O operations.

Parameters:

context - the instrumenting object which called this method.

subject - the subject of instrumentation.

Returns:

An instrumenting object or subject if the implementation does not want to instrument it.

See Also:

instrument(InstrumentingManager, FsController), instrument(InstrumentingCompositeDriver, FsController)

instrument

public <E extends net.java.truecommons.cio.Entry> InputStream instrument(InstrumentingInputSocket<This,E> context,
                                                                         InputStream subject)

Instruments the given subject.

Type Parameters:

E - the type of the target entry for I/O operations.

Parameters:

context - the instrumenting object which called this method.

subject - the subject of instrumentation.

Returns:

An instrumenting object or subject if the implementation does not want to instrument it.

See Also:

instrument(InstrumentingController, InputSocket), instrument(InstrumentingBuffer, InputSocket)

instrument

public <E extends net.java.truecommons.cio.Entry> SeekableByteChannel instrument(InstrumentingInputSocket<This,E> context,
                                                                                 SeekableByteChannel subject)

Instruments the given subject.

Type Parameters:

E - the type of the target entry for I/O operations.

Parameters:

context - the instrumenting object which called this method.

subject - the subject of instrumentation.

Returns:

An instrumenting object or subject if the implementation does not want to instrument it.

See Also:

instrument(InstrumentingController, InputSocket), instrument(InstrumentingBuffer, InputSocket)

instrument

public FsCompositeDriver instrument(InstrumentingManager<This> context,
                                    FsCompositeDriver subject)

Instruments the given subject.

Parameters:

context - the instrumenting object which called this method.

subject - the subject of instrumentation.

Returns:

An instrumenting object or subject if the implementation does not want to instrument it.

See Also:

instrument(FsManager)

instrument

public FsController instrument(InstrumentingManager<This> context,
                               FsController subject)

Instruments the given subject.

Parameters:

context - the instrumenting object which called this method.

subject - the subject of instrumentation.

Returns:

An instrumenting object or subject if the implementation does not want to instrument it.

See Also:

instrument(FsManager)

instrument

public <E extends net.java.truecommons.cio.Entry> OutputStream instrument(InstrumentingOutputSocket<This,E> context,
                                                                          OutputStream subject)

Instruments the given subject.

Type Parameters:

E - the type of the target entry for I/O operations.

Parameters:

context - the instrumenting object which called this method.

subject - the subject of instrumentation.

Returns:

An instrumenting object or subject if the implementation does not want to instrument it.

See Also:

instrument(InstrumentingController, OutputSocket), instrument(InstrumentingBuffer, OutputSocket)

instrument

public <E extends net.java.truecommons.cio.Entry> SeekableByteChannel instrument(InstrumentingOutputSocket<This,E> context,
                                                                                 SeekableByteChannel subject)

Instruments the given subject.

Type Parameters:

E - the type of the target entry for I/O operations.

Parameters:

context - the instrumenting object which called this method.

subject - the subject of instrumentation.

Returns:

An instrumenting object or subject if the implementation does not want to instrument it.

See Also:

instrument(InstrumentingController, OutputSocket), instrument(InstrumentingBuffer, OutputSocket)

instrument

public net.java.truecommons.cio.IoBufferPool instrument(net.java.truecommons.cio.IoBufferPool subject)

Instruments the given subject.

Parameters:

subject - the subject of instrumentation.

Returns:

An instrumenting object or subject if the implementation does not want to instrument it.