jruby/docs BETA
Navigation
org.apache.lucene.store 54
C AlreadyClosedException
C BaseDirectory
C BufferedChecksum
C BufferedChecksumIndexInput
C BufferedIndexInput
C ByteArrayDataInput
C ByteArrayDataOutput
C ByteBuffersDataInput
C ByteBuffersDataOutput
C ByteBuffersDirectory
C ByteBuffersIndexInput
C ByteBuffersIndexOutput
C ChecksumIndexInput
E DataAccessHint
C DataInput
C DataOutput
C Directory
C FSDirectory
C FSLockFactory
E FileDataHint
C FileSwitchDirectory
E FileTypeHint
C FilterDirectory
C FilterIndexInput
C FilterIndexOutput
I IOContext
C IndexInput
C IndexOutput
C InputStreamDataInput
C Lock
C LockFactory
C LockObtainFailedException
C LockReleaseFailedException
C LockStressTest
C LockValidatingDirectoryWrapper
C LockVerifyServer
C MMapDirectory
C NIOFSDirectory
C NRTCachingDirectory
C NativeFSLockFactory
C NoLockFactory
C OutputStreamDataOutput
C OutputStreamIndexOutput
E PreloadHint
I RandomAccessInput
C RateLimitedIndexOutput
C RateLimiter
E ReadAdvice
E ReadOnceHint
C SimpleFSLockFactory
C SingleInstanceLockFactory
C SleepingLockWrapper
C TrackingDirectoryWrapper
C VerifyingLockFactory
InputStreamDataInput — members 5+
C new(is)
C close()
M read_byte() byte
C read_bytes(b, offset, len)
C skip_bytes(num_bytes)
from DataInput
M clone() DataInput
C read_bytes(b, offset, len, use_buffer)
C read_floats(floats, offset, len)
C read_group_v_int(dst, offset)
M read_int() int
C read_ints(dst, offset, length)
M read_long() long
C read_longs(dst, offset, length)
M read_map_of_strings() Map<String,String>
M read_set_of_strings() Set<String>
M read_short() short
M read_string() String
M read_v_int() int
M read_v_long() long
M read_z_int() int
M read_z_long() long

org.apache.lucene.store.InputStreamDataInput

class extends DataInput implements Closeable 5 members

A DataInput wrapping a plain InputStream.

Constructors

new

new ( InputStream is )
Java: <init>(java.io.InputStream is)

Instance Methods

close

close ( )
Java: close()

read_byte

byte read_byte ( )
Java: readByte()

read_bytes

read_bytes ( byte[] b, int offset, int len )
Java: readBytes(byte[] b, int offset, int len)

skip_bytes

skip_bytes ( long num_bytes )
Java: skipBytes(long numBytes)

Inherited

from DataInput

clone

DataInput clone ( )
Java: clone()

Returns a clone of this stream.

Clones of a stream access the same data, and are positioned at the same point as the stream they were cloned from.

Expert: Subclasses must ensure that clones may be positioned at different points in the input from each other and from the stream they were cloned from.

read_bytes

read_bytes ( byte[] b, int offset, int len, boolean use_buffer )
Java: readBytes(byte[] b, int offset, int len, boolean useBuffer)

Reads a specified number of bytes into an array at the specified offset with control over whether the read should be buffered (callers who have their own buffer should pass in "false" for useBuffer). Currently only BufferedIndexInput respects this parameter.

nametypedescription
bbyte[]the array to read bytes into
offsetintthe offset in the array to start storing bytes
lenintthe number of bytes to read
use_bufferbooleanset to false if the caller will handle buffering.

read_floats

read_floats ( float[] floats, int offset, int len )
Java: readFloats(float[] floats, int offset, int len)

Reads a specified number of floats into an array at the specified offset.

nametypedescription
floatsfloat[]the array to read bytes into
offsetintthe offset in the array to start storing floats
lenintthe number of floats to read

read_group_v_int

read_group_v_int ( int[] dst, int offset )
Java: readGroupVInt(int[] dst, int offset)
Deprecated. This method is no longer called by Lucene. It is only kept for backwards compatibility. Code calling this method should migrate to GroupVIntUtil#readGroupVInts(DataInput, int[], int) to decode a full group including tails instead.

Legacy: This method allowed to implement GroupVInt encoding in a more efficient way when this implementation supports random access. It is no longer called by Lucene's code.

If you have implemented this method, simply remove it!

read_int

int read_int ( )
Java: readInt()

Reads four bytes and returns an int (LE byte order).

read_ints

read_ints ( int[] dst, int offset, int length )
Java: readInts(int[] dst, int offset, int length)

Reads a specified number of ints into an array at the specified offset.

nametypedescription
dstint[]the array to read bytes into
offsetintthe offset in the array to start storing ints
lengthintthe number of ints to read

read_long

long read_long ( )
Java: readLong()

Reads eight bytes and returns a long (LE byte order).

read_longs

read_longs ( long[] dst, int offset, int length )
Java: readLongs(long[] dst, int offset, int length)

Read a specified number of longs.

read_map_of_strings

Map<String,String> read_map_of_strings ( )
Java: readMapOfStrings()

Reads a Map<String,String> previously written with DataOutput#writeMapOfStrings(Map).

Returns: An immutable map containing the written contents.

read_set_of_strings

Set<String> read_set_of_strings ( )
Java: readSetOfStrings()

Reads a Set<String> previously written with DataOutput#writeSetOfStrings(Set).

Returns: An immutable set containing the written contents.

read_short

short read_short ( )
Java: readShort()

Reads two bytes and returns a short (LE byte order).

read_string

String read_string ( )
Java: readString()

Reads a string.

read_v_int

int read_v_int ( )
Java: readVInt()

Reads an int stored in variable-length format. Reads between one and five bytes. Smaller values take fewer bytes. Negative numbers are supported, but should be avoided.

The format is described further in DataOutput#writeVInt(int).

read_v_long

long read_v_long ( )
Java: readVLong()

Reads a long stored in variable-length format. Reads between one and nine bytes. Smaller values take fewer bytes. Negative numbers are not supported.

The format is described further in DataOutput#writeVInt(int).

read_z_int

int read_z_int ( )
Java: readZInt()

Read a zig-zag-encoded variable-length integer.

read_z_long

long read_z_long ( )
Java: readZLong()

Read a zig-zag-encoded variable-length integer. Reads between one and ten bytes.

this work for additional information regarding copyright ownership.