org.apache.lucene.facet.index

Class CategoryListPayloadStream

java.lang.Object

org.apache.lucene.facet.index.CategoryListPayloadStream

public class CategoryListPayloadStream
extends java.lang.Object

Accumulates category IDs for a single document, for writing in byte array form, for example, to a Lucene Payload.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Constructor Summary

Constructors

Constructor and Description
CategoryListPayloadStream(IntEncoder encoder) Creates a Payload stream using the specified encoder.

Method Summary

Modifier and Type	Method and Description
void	appendIntToStream(int intValue) Appends an integer to the stream.
byte[]	convertStreamToByteArray() Returns the streamed bytes so far accumulated, as an array of bytes.
void	reset() Resets this stream to begin building a new payload.

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoryListPayloadStream

public CategoryListPayloadStream(IntEncoder encoder)

Creates a Payload stream using the specified encoder.

Method Detail

appendIntToStream

public void appendIntToStream(int intValue)
                       throws java.io.IOException

Appends an integer to the stream.

Throws:

java.io.IOException

convertStreamToByteArray

public byte[] convertStreamToByteArray()

Returns the streamed bytes so far accumulated, as an array of bytes.

reset

public void reset()
           throws java.io.IOException

Resets this stream to begin building a new payload.

Throws:

java.io.IOException