jetbrains.exodus

Class FileByteIterable

java.lang.Object

jetbrains.exodus.FileByteIterable

All Implemented Interfaces:

java.lang.Comparable<ByteIterable>, ByteIterable

public class FileByteIterable
extends java.lang.Object
implements ByteIterable

An adapter to the contents of a region of a file. Doesn't support getBytesUnsafe() as it unconditionally throws UnsupportedOperationException. Avoid using this class with Android API level less than 26.

Field Summary

Fields inherited from interface jetbrains.exodus.ByteIterable

EMPTY, EMPTY_BYTES, EMPTY_ITERATOR

Constructor Summary

Constructors

Constructor and Description
FileByteIterable(@NotNull java.io.File file)
FileByteIterable(@NotNull java.io.File file, long offset, int len)

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	asStream()
int	compareTo(@NotNull ByteIterable right)
byte[]	getBytesUnsafe()
int	getLength()
ByteIterator	iterator()
@NotNull ByteIterable	subIterable(int offset, int length)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileByteIterable

public FileByteIterable(@NotNull
                        @NotNull java.io.File file)

FileByteIterable

public FileByteIterable(@NotNull
                        @NotNull java.io.File file,
                        long offset,
                        int len)

Method Detail

iterator

public ByteIterator iterator()

Specified by:

iterator in interface ByteIterable

getBytesUnsafe

public byte[] getBytesUnsafe()

Specified by:

getBytesUnsafe in interface ByteIterable

Returns:

nothing since unconditionally throws UnsupportedOperationException.

Throws:

java.lang.UnsupportedOperationException - always since this operation is unsupported

getLength

public int getLength()

Specified by:

getLength in interface ByteIterable

Returns:

length of the ByteIterable.

subIterable

@NotNull
public @NotNull ByteIterable subIterable(int offset,
                                                   int length)

Specified by:

subIterable in interface ByteIterable

Parameters:

offset - start offset, inclusive

length - length of the sub-iterable

Returns:

a fixed-length sub-iterable of the ByteIterable starting from offset.

compareTo

public int compareTo(@NotNull
                     @NotNull ByteIterable right)

Specified by:

compareTo in interface java.lang.Comparable<ByteIterable>

asStream

public java.io.InputStream asStream()
                             throws java.io.IOException

Throws:

java.io.IOException