Package nonapi.io.github.classgraph.fileslice

Class FileSlice

java.lang.Object

nonapi.io.github.classgraph.fileslice.Slice

nonapi.io.github.classgraph.fileslice.FileSlice

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class FileSlice
extends Slice

A File slice.

Field Summary

Fields

Modifier and Type	Field	Description
private java.nio.ByteBuffer	backingByteBuffer	The backing byte buffer, if any.
java.io.File	file	The File.
private java.nio.channels.FileChannel	fileChannel	The file channel.
private long	fileLength	The file length.
private java.util.concurrent.atomic.AtomicBoolean	isClosed	True if close() has been called.
private boolean	isTopLevelFileSlice	True if this is a top level file slice.
java.io.RandomAccessFile	raf	The RandomAccessFile opened on the File.

Fields inherited from class nonapi.io.github.classgraph.fileslice.Slice

inflatedLengthHint, isDeflatedZipEntry, nestedJarHandler, parentSlice, sliceLength, sliceStartPos

Constructor Summary

Constructors

Modifier	Constructor	Description
	FileSlice(java.io.File file, boolean isDeflatedZipEntry, long inflatedLengthHint, NestedJarHandler nestedJarHandler, LogNode log)	Constructor for toplevel file slice.
	FileSlice(java.io.File file, NestedJarHandler nestedJarHandler, LogNode log)	Constructor for toplevel file slice.
private	FileSlice(FileSlice parentSlice, long offset, long length, boolean isDeflatedZipEntry, long inflatedLengthHint, NestedJarHandler nestedJarHandler)	Constructor for treating a range of a file as a slice.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the slice.
boolean	equals(java.lang.Object o)
int	hashCode()
byte[]	load()	Load the slice as a byte array.
RandomAccessReader	randomAccessReader()	Read directly from FileChannel (slow path, but handles >2GB).
java.nio.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 nonapi.io.github.classgraph.fileslice.Slice

loadAsString, open, open

Methods inherited from class java.lang.Object

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

Field Detail

file

public final java.io.File file

The File.

raf

public java.io.RandomAccessFile raf

The RandomAccessFile opened on the File.

fileLength

private final long fileLength

The file length.

fileChannel

private java.nio.channels.FileChannel fileChannel

The file channel.

backingByteBuffer

private java.nio.ByteBuffer backingByteBuffer

The backing byte buffer, if any.

isTopLevelFileSlice

private final boolean isTopLevelFileSlice

True if this is a top level file slice.

isClosed

private final java.util.concurrent.atomic.AtomicBoolean isClosed

True if close() has been called.

Constructor Detail

FileSlice

private FileSlice(FileSlice parentSlice,
                  long offset,
                  long length,
                  boolean isDeflatedZipEntry,
                  long inflatedLengthHint,
                  NestedJarHandler nestedJarHandler)

Constructor for treating a range of a file as a slice.

Parameters:

parentSlice - the parent slice

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.

nestedJarHandler - the nested jar handler

FileSlice

public FileSlice(java.io.File file,
                 boolean isDeflatedZipEntry,
                 long inflatedLengthHint,
                 NestedJarHandler nestedJarHandler,
                 LogNode log)
          throws java.io.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:

java.io.IOException - if the file cannot be opened.

FileSlice

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

Constructor for toplevel file slice.

Parameters:

file - the file

nestedJarHandler - the nested jar handler

log - the log

Throws:

java.io.IOException - if the file cannot be opened.

Method Detail

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 java.io.IOException

Load the slice as a byte array.

Specified by:

load in class Slice

Returns:

the byte[]

Throws:

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

read

public java.nio.ByteBuffer read()
                         throws java.io.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:

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

equals

public boolean equals(java.lang.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 java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Overrides:

close in class Slice