MockIndexInputWrapper (Grandparent POM for Apache Lucene Core and Apache Solr 4.10.4 API)

java.lang.Object
- org.apache.lucene.store.DataInput
- - org.apache.lucene.store.IndexInput
  - - org.apache.lucene.store.MockIndexInputWrapper

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable
```
public class MockIndexInputWrapper
extends IndexInput
```
Used by MockDirectoryWrapper to create an input stream that keeps track of when it's been closed.

Constructor Summary

Constructors
Constructor and Description
`MockIndexInputWrapper(MockDirectoryWrapper dir, String name, IndexInput delegate)` Construct an empty output buffer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MockIndexInputWrapper`	`clone()` Returns a clone of this stream.
`void`	`close()` Closes the stream to further operations.
`long`	`getFilePointer()` Returns the current position in this file, where the next read will occur.
`long`	`length()` The number of bytes in the file.
`byte`	`readByte()` Reads and returns a single byte.
`void`	`readBytes(byte[] b, int offset, int len)` Reads a specified number of bytes into an array at the specified offset.
`void`	`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).
`int`	`readInt()` Reads four bytes and returns an int.
`long`	`readLong()` Reads eight bytes and returns a long.
`short`	`readShort()` Reads two bytes and returns a short.
`String`	`readString()` Reads a string.
`Map<String,String>`	`readStringStringMap()` Reads a Map<String,String> previously written with `DataOutput.writeStringStringMap(Map)`.
`int`	`readVInt()` Reads an int stored in variable-length format.
`long`	`readVLong()` Reads a long stored in variable-length format.
`void`	`seek(long pos)` Sets current position in this file, where the next read will occur.
`IndexInput`	`slice(String sliceDescription, long offset, long length)` Creates a slice of this index input, with the given description, offset, and length.
`String`	`toString()`

Methods inherited from class org.apache.lucene.store.IndexInput
randomAccessSlice

Methods inherited from class org.apache.lucene.store.DataInput
readStringSet, readZInt, readZLong, skipBytes

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MockIndexInputWrapper
```
public MockIndexInputWrapper(MockDirectoryWrapper dir,
                             String name,
                             IndexInput delegate)
```
    Construct an empty output buffer.
- Method Detail
  - close
```
public void close()
           throws IOException
```
    Description copied from class: IndexInput
    
    Closes the stream to further operations.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in class IndexInput
    
    Throws:
    
    IOException
  - clone
```
public MockIndexInputWrapper clone()
```
    Description copied from class: IndexInput
    
    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.
    Warning: Lucene never closes cloned IndexInputs, it will only do this on the original one. The original instance must take care that cloned instances throw AlreadyClosedException when the original one is closed.
    
    Overrides:
    
    clone in class IndexInput
  - slice
```
public IndexInput slice(String sliceDescription,
                        long offset,
                        long length)
                 throws IOException
```
    Description copied from class: IndexInput
    
    Creates a slice of this index input, with the given description, offset, and length. The slice is seeked to the beginning.
    
    Specified by:
    
    slice in class IndexInput
    
    Throws:
    
    IOException
  - getFilePointer
```
public long getFilePointer()
```
    Description copied from class: IndexInput
    
    Returns the current position in this file, where the next read will occur.
    
    Specified by:
    
    getFilePointer in class IndexInput
    
    See Also:
    
    IndexInput.seek(long)
  - seek
```
public void seek(long pos)
          throws IOException
```
    Description copied from class: IndexInput
    
    Sets current position in this file, where the next read will occur.
    
    Specified by:
    
    seek in class IndexInput
    
    Throws:
    
    IOException
    
    See Also:
    
    IndexInput.getFilePointer()
  - length
```
public long length()
```
    Description copied from class: IndexInput
    
    The number of bytes in the file.
    
    Specified by:
    
    length in class IndexInput
  - readByte
```
public byte readByte()
              throws IOException
```
    Description copied from class: DataInput
    
    Reads and returns a single byte.
    
    Specified by:
    
    readByte in class DataInput
    
    Throws:
    
    IOException
    
    See Also:
    
    DataOutput.writeByte(byte)
  - readBytes
```
public void readBytes(byte[] b,
                      int offset,
                      int len)
               throws IOException
```
    Description copied from class: DataInput
    
    Reads a specified number of bytes into an array at the specified offset.
    
    Specified by:
    
    readBytes in class DataInput
    
    Parameters:
    
    b - the array to read bytes into
    
    offset - the offset in the array to start storing bytes
    
    len - the number of bytes to read
    
    Throws:
    
    IOException
    
    See Also:
    
    DataOutput.writeBytes(byte[],int)
  - readBytes
```
public void readBytes(byte[] b,
                      int offset,
                      int len,
                      boolean useBuffer)
               throws IOException
```
    Description copied from class: DataInput
    
    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.
    
    Overrides:
    
    readBytes in class DataInput
    
    Parameters:
    
    b - the array to read bytes into
    
    offset - the offset in the array to start storing bytes
    
    len - the number of bytes to read
    
    useBuffer - set to false if the caller will handle buffering.
    
    Throws:
    
    IOException
    
    See Also:
    
    DataOutput.writeBytes(byte[],int)
  - readShort
```
public short readShort()
                throws IOException
```
    Description copied from class: DataInput
    
    Reads two bytes and returns a short.
    
    Overrides:
    
    readShort in class DataInput
    
    Throws:
    
    IOException
    
    See Also:
    
    DataOutput.writeByte(byte)
  - readInt
```
public int readInt()
            throws IOException
```
    Description copied from class: DataInput
    
    Reads four bytes and returns an int.
    
    Overrides:
    
    readInt in class DataInput
    
    Throws:
    
    IOException
    
    See Also:
    
    DataOutput.writeInt(int)
  - readLong
```
public long readLong()
              throws IOException
```
    Description copied from class: DataInput
    
    Reads eight bytes and returns a long.
    
    Overrides:
    
    readLong in class DataInput
    
    Throws:
    
    IOException
    
    See Also:
    
    DataOutput.writeLong(long)
  - readString
```
public String readString()
                  throws IOException
```
    Description copied from class: DataInput
    
    Reads a string.
    
    Overrides:
    
    readString in class DataInput
    
    Throws:
    
    IOException
    
    See Also:
    
    DataOutput.writeString(String)
  - readStringStringMap
```
public Map<String,String> readStringStringMap()
                                       throws IOException
```
    Description copied from class: DataInput
    
    Reads a Map<String,String> previously written with DataOutput.writeStringStringMap(Map).
    
    Overrides:
    
    readStringStringMap in class DataInput
    
    Throws:
    
    IOException
  - readVInt
```
public int readVInt()
             throws IOException
```
    Description copied from class: DataInput
    
    Reads an int stored in variable-length format. Reads between one and five bytes. Smaller values take fewer bytes. Negative numbers are not supported.
    The format is described further in DataOutput.writeVInt(int).
    
    Overrides:
    
    readVInt in class DataInput
    
    Throws:
    
    IOException
    
    See Also:
    
    DataOutput.writeVInt(int)
  - readVLong
```
public long readVLong()
               throws IOException
```
    Description copied from class: DataInput
    
    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).
    
    Overrides:
    
    readVLong in class DataInput
    
    Throws:
    
    IOException
    
    See Also:
    
    DataOutput.writeVLong(long)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class IndexInput

Class MockIndexInputWrapper

Constructor Summary

Method Summary

Methods inherited from class org.apache.lucene.store.IndexInput

Methods inherited from class org.apache.lucene.store.DataInput

Methods inherited from class java.lang.Object

Constructor Detail

MockIndexInputWrapper

Method Detail

close

clone

slice

getFilePointer

seek

length

readByte

readBytes

readBytes

readShort

readInt

readLong

readString

readStringStringMap

readVInt

readVLong

toString