org.apache.lucene.store

Class IndexOutput

public abstract class IndexOutput extends Object

Abstract base class for output to a file in a Directory. A random-access output stream. Used for all Lucene index output operations.

See Also: Directory IndexInput

Method Summary
abstract voidclose()
Closes this stream to further operations.
abstract voidflush()
Forces any buffered output to be written.
abstract longgetFilePointer()
Returns the current position in this file, where the next write will occur.
abstract longlength()
The number of bytes in the file.
abstract voidseek(long pos)
Sets current position in this file, where the next write will occur.
abstract voidwriteByte(byte b)
Writes a single byte.
abstract voidwriteBytes(byte[] b, int length)
Writes an array of bytes.
voidwriteChars(String s, int start, int length)
Writes a sequence of UTF-8 encoded characters from a string.
voidwriteInt(int i)
Writes an int as four bytes.
voidwriteLong(long i)
Writes a long as eight bytes.
voidwriteString(String s)
Writes a string.
voidwriteVInt(int i)
Writes an int in a variable-length format.
voidwriteVLong(long i)
Writes an long in a variable-length format.

Method Detail

close

public abstract void close()
Closes this stream to further operations.

flush

public abstract void flush()
Forces any buffered output to be written.

getFilePointer

public abstract long getFilePointer()
Returns the current position in this file, where the next write will occur.

See Also: IndexOutput

length

public abstract long length()
The number of bytes in the file.

seek

public abstract void seek(long pos)
Sets current position in this file, where the next write will occur.

See Also: getFilePointer

writeByte

public abstract void writeByte(byte b)
Writes a single byte.

See Also: readByte

writeBytes

public abstract void writeBytes(byte[] b, int length)
Writes an array of bytes.

Parameters: b the bytes to write length the number of bytes to write

See Also: (byte[],int,int)

writeChars

public void writeChars(String s, int start, int length)
Writes a sequence of UTF-8 encoded characters from a string.

Parameters: s the source of the characters start the first character in the sequence length the number of characters in the sequence

See Also: (char[],int,int)

writeInt

public void writeInt(int i)
Writes an int as four bytes.

See Also: readInt

writeLong

public void writeLong(long i)
Writes a long as eight bytes.

See Also: readLong

writeString

public void writeString(String s)
Writes a string.

See Also: readString

writeVInt

public void writeVInt(int i)
Writes an int in a variable-length format. Writes between one and five bytes. Smaller values take fewer bytes. Negative numbers are not supported.

See Also: readVInt

writeVLong

public void writeVLong(long i)
Writes an long in a variable-length format. Writes between one and five bytes. Smaller values take fewer bytes. Negative numbers are not supported.

See Also: readVLong

Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.