org.apache.lucene.util

Class OfflineSorter.ByteSequencesWriter

java.lang.Object

org.apache.lucene.util.OfflineSorter.ByteSequencesWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Enclosing class:

OfflineSorter

public static class OfflineSorter.ByteSequencesWriter
extends java.lang.Object
implements java.io.Closeable

Utility class to emit length-prefixed byte[] entries to an output stream for sorting. Complementary to OfflineSorter.ByteSequencesReader. You must use CodecUtil.writeFooter(org.apache.lucene.store.IndexOutput) to write a footer at the end of the input file.

Field Summary

Fields

Modifier and Type	Field and Description
protected IndexOutput	out

Constructor Summary

Constructors

Constructor and Description
ByteSequencesWriter(IndexOutput out) Constructs a ByteSequencesWriter to the provided DataOutput

Method Summary

Modifier and Type	Method and Description
void	close() Closes the provided IndexOutput.
void	write(byte[] bytes) Writes a byte array.
void	write(byte[] bytes, int off, int len) Writes a byte array.
void	write(BytesRef ref) Writes a BytesRef.

Methods inherited from class java.lang.Object

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

Field Detail

out

protected final IndexOutput out

Constructor Detail

ByteSequencesWriter

public ByteSequencesWriter(IndexOutput out)

Constructs a ByteSequencesWriter to the provided DataOutput

Method Detail

write

public final void write(BytesRef ref)
                 throws java.io.IOException

Writes a BytesRef.

Throws:

java.io.IOException

See Also:

write(byte[], int, int)

write

public final void write(byte[] bytes)
                 throws java.io.IOException

Writes a byte array.

Throws:

java.io.IOException

See Also:

write(byte[], int, int)

write

public void write(byte[] bytes,
                  int off,
                  int len)
           throws java.io.IOException

Writes a byte array.

The length is written as a short, followed by the bytes.

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Closes the provided IndexOutput.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException