Lucene++ - a full-featured, c++ search engine
API Documentation
Abstract class for reading character streams. More...
#include <Reader.h>
Public Member Functions | |
virtual | ~Reader () |
virtual String | getClassName () |
boost::shared_ptr< Reader > | shared_from_this () |
virtual int32_t | read () |
Read a single character. | |
virtual int32_t | read (wchar_t *buffer, int32_t offset, int32_t length)=0 |
Read characters into a portion of an array. | |
virtual int64_t | skip (int64_t n) |
Skip characters. | |
virtual void | close ()=0 |
Close the stream. | |
virtual bool | markSupported () |
Tell whether this stream supports the mark() operation. | |
virtual void | mark (int32_t readAheadLimit) |
Mark the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point. | |
virtual void | reset () |
Reset the stream. If the stream has been marked, then attempt to reposition it at the mark. If the stream has not been marked, then attempt to reset it in some way appropriate to the particular stream, for example by repositioning it to its starting point. | |
virtual int64_t | length () |
The number of bytes in the stream. | |
![]() | |
virtual | ~LuceneObject () |
virtual void | initialize () |
Called directly after instantiation to create objects that depend on this object being fully constructed. | |
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Return clone of this object. | |
virtual int32_t | hashCode () |
Return hash code for this object. | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. | |
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
Compare two objects. | |
virtual String | toString () |
Returns a string representation of the object. | |
![]() | |
virtual | ~LuceneSync () |
virtual SynchronizePtr | getSync () |
Return this object synchronize lock. | |
virtual LuceneSignalPtr | getSignal () |
Return this object signal. | |
virtual void | lock (int32_t timeout=0) |
Lock this object using an optional timeout. | |
virtual void | unlock () |
Unlock this object. | |
virtual bool | holdsLock () |
Returns true if this object is currently locked by current thread. | |
virtual void | wait (int32_t timeout=0) |
Wait for signal using an optional timeout. | |
virtual void | notifyAll () |
Notify all threads waiting for signal. | |
Static Public Member Functions | |
static String | _getClassName () |
Static Public Attributes | |
static const int32_t | READER_EOF |
Protected Member Functions | |
Reader () | |
![]() | |
LuceneObject () | |
Additional Inherited Members | |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Abstract class for reading character streams.
|
protected |
|
virtual |
|
inlinestatic |
|
pure virtual |
Close the stream.
Implemented in Lucene::BufferedReader, Lucene::CharFilter, Lucene::CharReader, Lucene::FileReader, Lucene::InputStreamReader, Lucene::ReusableStringReader, and Lucene::StringReader.
|
inlinevirtual |
|
virtual |
The number of bytes in the stream.
Reimplemented in Lucene::FileReader, and Lucene::StringReader.
|
virtual |
Mark the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point.
Reimplemented in Lucene::CharFilter, and Lucene::CharReader.
|
virtual |
Tell whether this stream supports the mark() operation.
Reimplemented in Lucene::BufferedReader, Lucene::CharFilter, Lucene::CharReader, Lucene::FileReader, Lucene::InputStreamReader, and Lucene::StringReader.
|
virtual |
Read a single character.
Reimplemented in Lucene::BufferedReader, Lucene::FileReader, Lucene::InputStreamReader, Lucene::MappingCharFilter, Lucene::ReusableStringReader, and Lucene::StringReader.
|
pure virtual |
Read characters into a portion of an array.
Implemented in Lucene::BufferedReader, Lucene::InputStreamReader, Lucene::CharFilter, Lucene::CharReader, Lucene::FileReader, Lucene::MappingCharFilter, Lucene::ReusableStringReader, Lucene::StringReader, and Lucene::ReusableStringReader.
|
virtual |
Reset the stream. If the stream has been marked, then attempt to reposition it at the mark. If the stream has not been marked, then attempt to reset it in some way appropriate to the particular stream, for example by repositioning it to its starting point.
Reimplemented in Lucene::BufferedReader, Lucene::CharFilter, Lucene::CharReader, Lucene::FileReader, Lucene::InputStreamReader, and Lucene::StringReader.
|
inline |
|
virtual |
Skip characters.
|
static |