SimplePipe (OGSA-DAI -- (c) International Business Machines Corporation, 2002-2006, The University of Edinburgh, 2002-2006)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

uk.org.ogsadai.engine
Class SimplePipe

java.lang.Object
  |
  +--uk.org.ogsadai.engine.SimplePipe

All Implemented Interfaces:: BlockReader, BlockWriter, Pipe

public class SimplePipe
extends java.lang.Object
implements Pipe

A simple implementation of a Pipe that can contain a single object.

Author:: The OGSA-DAI Project Team

Field Summary
`private static java.lang.String`	`COPYRIGHT_NOTICE` Copyright statement
`private boolean`	`mClosed` Indicates whether or not the pipe has been closed.
`private java.lang.Object`	`mData` Data in pipe
`private boolean`	`mHasNext` Is there more data?

Constructor Summary
`SimplePipe(java.lang.Object data)` Create a new pipe.

Method Summary
`void`	`close()` Closes the block writer to indicate that there are no more blocks are to be written.
`boolean`	`hasNext()` Indicates whether or not there are any more blocks of data to be read from the block reader.
`boolean`	`isOpen()` Indicates whether or not the block writer is open for writing via the `put` method.
`java.lang.Object`	`next()` Gets the next block of data contained in the block reader.
`void`	`put(java.lang.Object block)` Writes the specified block of output data.

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT_NOTICE

private static final java.lang.String COPYRIGHT_NOTICE

See Also:: Constant Field Values

mData

private java.lang.Object mData

Data in pipe

mHasNext

private boolean mHasNext

Is there more data?

mClosed

private boolean mClosed

Indicates whether or not the pipe has been closed.

Constructor Detail

SimplePipe

public SimplePipe(java.lang.Object data)

Create a new pipe.
Parameters:: data - Initial data in pipe.

Method Detail

public java.lang.Object next()

Description copied from interface: BlockReader

Gets the next block of data contained in the block reader.

Specified by:: next in interface BlockReader

Returns:: an Object

hasNext

public boolean hasNext()

Description copied from interface: BlockReader

Indicates whether or not there are any more blocks of data to be read from the block reader.

Specified by:: hasNext in interface BlockReader

Returns:: true if there are more blocks to be read or false otherwise

put

public void put(java.lang.Object block)

Description copied from interface: BlockWriter

Writes the specified block of output data.

Specified by:: put in interface BlockWriter

Parameters:: block - the Object block to write

close

public void close()

Description copied from interface: BlockWriter

Closes the block writer to indicate that there are no more blocks are to be written. After close has been called, the put method should no longer be used.

Specified by:: close in interface BlockWriter

isOpen

public boolean isOpen()

Description copied from interface: BlockWriter

Indicates whether or not the block writer is open for writing via the put method. After the close method has been invoked this method should return false.