Package org.apache.manifoldcf.core.interfaces

Class NullCharacterInput

java.lang.Object

org.apache.manifoldcf.core.interfaces.PersistentDatabaseObject

org.apache.manifoldcf.core.interfaces.CharacterInput

org.apache.manifoldcf.core.interfaces.NullCharacterInput

public class NullCharacterInput
extends CharacterInput

This class represents a null character stream, which has no characters.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	_rcsid

Fields inherited from class org.apache.manifoldcf.core.interfaces.CharacterInput

charLength, hashValue, stream

Constructor Summary

Constructors

Constructor	Description
NullCharacterInput()	Construct from nothing.

Method Summary

Modifier and Type	Method	Description
protected void	calculateHashValue()	Calculate the datum's hash value
protected void	calculateLength()	Calculate the datum's length in characters
protected void	closeStream()	Close any open reader
void	discard()	Discard this object permanently
void	doneWithStream()	Close any open streams, but do NOT remove the backing object.
long	getCharacterLength()
java.lang.String	getHashValue()
java.io.Reader	getStream()
java.io.InputStream	getUtf8Stream()	Open a Utf8 stream directly
long	getUtf8StreamLength()	Get binary UTF8 stream length directly
protected void	openStream()	Open a reader, for use by a caller, until closeStream is called
CharacterInput	transfer()	Transfer to a new object; this causes the current object to become "already discarded"

Methods inherited from class org.apache.manifoldcf.core.interfaces.CharacterInput

handleIOException

Methods inherited from class java.lang.Object

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

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

Constructor Detail

NullCharacterInput

public NullCharacterInput()

Construct from nothing.

Method Detail

getStream

public java.io.Reader getStream()
                         throws ManifoldCFException

Overrides:

getStream in class CharacterInput

Throws:

ManifoldCFException

doneWithStream

public void doneWithStream()
                    throws ManifoldCFException

Description copied from class: PersistentDatabaseObject

Close any open streams, but do NOT remove the backing object. Thus the stream can be reopened in the future.

Overrides:

doneWithStream in class CharacterInput

Throws:

ManifoldCFException

getCharacterLength

public long getCharacterLength()
                        throws ManifoldCFException

Overrides:

getCharacterLength in class CharacterInput

Throws:

ManifoldCFException

getHashValue

public java.lang.String getHashValue()
                              throws ManifoldCFException

Overrides:

getHashValue in class CharacterInput

Throws:

ManifoldCFException

getUtf8Stream

public java.io.InputStream getUtf8Stream()
                                  throws ManifoldCFException

Open a Utf8 stream directly

Specified by:

getUtf8Stream in class CharacterInput

Throws:

ManifoldCFException

getUtf8StreamLength

public long getUtf8StreamLength()
                         throws ManifoldCFException

Get binary UTF8 stream length directly

Specified by:

getUtf8StreamLength in class CharacterInput

Throws:

ManifoldCFException

transfer

public CharacterInput transfer()

Transfer to a new object; this causes the current object to become "already discarded"

Specified by:

transfer in class CharacterInput

discard

public void discard()
             throws ManifoldCFException

Discard this object permanently

Overrides:

discard in class CharacterInput

Throws:

ManifoldCFException

openStream

protected void openStream()
                   throws ManifoldCFException

Open a reader, for use by a caller, until closeStream is called

Specified by:

openStream in class CharacterInput

Throws:

ManifoldCFException

closeStream

protected void closeStream()
                    throws ManifoldCFException

Close any open reader

Overrides:

closeStream in class CharacterInput

Throws:

ManifoldCFException

calculateLength

protected void calculateLength()
                        throws ManifoldCFException

Calculate the datum's length in characters

Specified by:

calculateLength in class CharacterInput

Throws:

ManifoldCFException

calculateHashValue

protected void calculateHashValue()
                           throws ManifoldCFException

Calculate the datum's hash value

Specified by:

calculateHashValue in class CharacterInput

Throws:

ManifoldCFException