Class FileSlice

java.lang.Object

nonapi.io.github.classgraph.fileslice.Slice

nonapi.io.github.classgraph.fileslice.FileSlice

All Implemented Interfaces:

Closeable, AutoCloseable

public class FileSlice
extends Slice

A File slice.

Field Summary

Fields

Modifier and Type	Field	Description
final File	file	The File.
RandomAccessFile	raf	The RandomAccessFile opened on the File.

Fields inherited from class Slice

inflatedLengthHint, isDeflatedZipEntry, nestedJarHandler, parentSlice, sliceLength, sliceStartPos

Constructor Summary

Constructors

Constructor	Description
FileSlice(File file, boolean isDeflatedZipEntry, long inflatedLengthHint, NestedJarHandler nestedJarHandler, LogNode log)	Constructor for toplevel file slice.
FileSlice(File file, NestedJarHandler nestedJarHandler, LogNode log)	Constructor for toplevel file slice.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the slice.
boolean	equals(Object o)
int	hashCode()
byte[]	load()	Load the slice as a byte array.
RandomAccessReader	randomAccessReader()	Read directly from FileChannel (slow path, but handles >2GB).
ByteBuffer	read()	Read the slice into a ByteBuffer (or memory-map the slice to a MappedByteBuffer, if ClassGraph.enableMemoryMapping() was called.)
Slice	slice(long offset, long length, boolean isDeflatedZipEntry, long inflatedLengthHint)	Slice the file.

Methods inherited from class Slice

loadAsString, open, open

Methods inherited from class Object

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

Field Details

file

public final File file

The File.

raf

public RandomAccessFile raf

The RandomAccessFile opened on the File.

Constructor Details

FileSlice

public FileSlice(File file,
 boolean isDeflatedZipEntry,
 long inflatedLengthHint,
 NestedJarHandler nestedJarHandler,
 LogNode log)
          throws IOException

Constructor for toplevel file slice.

Parameters:

file - the file

isDeflatedZipEntry - true if this is a deflated zip entry

inflatedLengthHint - the uncompressed size of a deflated zip entry, or -1 if unknown, or 0 of this is not a deflated zip entry.

nestedJarHandler - the nested jar handler

log - the log

Throws:

IOException - if the file cannot be opened.

FileSlice

public FileSlice(File file,
 NestedJarHandler nestedJarHandler,
 LogNode log)
          throws IOException

Constructor for toplevel file slice.

Parameters:

file - the file

nestedJarHandler - the nested jar handler

log - the log

Throws:

IOException - if the file cannot be opened.

Method Details

slice

public Slice slice(long offset,
 long length,
 boolean isDeflatedZipEntry,
 long inflatedLengthHint)

Slice the file.

Specified by:

slice in class Slice

Parameters:

offset - the offset of the sub-slice within the parent slice

length - the length of the sub-slice

isDeflatedZipEntry - true if this is a deflated zip entry

inflatedLengthHint - the uncompressed size of a deflated zip entry, or -1 if unknown, or 0 of this is not a deflated zip entry.

Returns:

the slice

randomAccessReader

public RandomAccessReader randomAccessReader()

Read directly from FileChannel (slow path, but handles >2GB).

Specified by:

randomAccessReader in class Slice

Returns:

the random access reader

load

public byte[] load()
            throws IOException

Load the slice as a byte array.

Specified by:

load in class Slice

Returns:

the byte[]

Throws:

IOException - Signals that an I/O exception has occurred.

read

public ByteBuffer read()
                throws IOException

Read the slice into a ByteBuffer (or memory-map the slice to a MappedByteBuffer, if ClassGraph.enableMemoryMapping() was called.)

Overrides:

read in class Slice

Returns:

the byte buffer

Throws:

IOException - Signals that an I/O exception has occurred.

equals

public boolean equals(Object o)

Overrides:

equals in class Slice

hashCode

public int hashCode()

Overrides:

hashCode in class Slice

close

public void close()

Close the slice. Unmaps any backing MappedByteBuffer.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class Slice