Package nonapi.io.github.classgraph.fileslice

Class PathSlice

java.lang.Object

nonapi.io.github.classgraph.fileslice.Slice

nonapi.io.github.classgraph.fileslice.PathSlice

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class PathSlice
extends Slice

A Path slice.

Field Summary

Fields

Modifier and Type	Field	Description
private java.nio.channels.FileChannel	fileChannel	The FileChannel opened on the Path.
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.nio.file.Path	path	The Path.

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

inflatedLengthHint, isDeflatedZipEntry, nestedJarHandler, parentSlice, sliceLength, sliceStartPos

Constructor Summary

Constructors

Modifier	Constructor	Description
	PathSlice(java.nio.file.Path path, boolean isDeflatedZipEntry, long inflatedLengthHint, NestedJarHandler nestedJarHandler)	Constructor for toplevel file slice.
	PathSlice(java.nio.file.Path path, boolean isDeflatedZipEntry, long inflatedLengthHint, NestedJarHandler nestedJarHandler, boolean checkAccess)	Constructor for toplevel file slice.
	PathSlice(java.nio.file.Path path, NestedJarHandler nestedJarHandler)	Constructor for toplevel file slice.
private	PathSlice(PathSlice 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

path

public final java.nio.file.Path path

The Path.

fileLength

private final long fileLength

The file length.

fileChannel

private java.nio.channels.FileChannel fileChannel

The FileChannel opened on the Path.

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

PathSlice

private PathSlice(PathSlice 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

PathSlice

public PathSlice(java.nio.file.Path path,
                 boolean isDeflatedZipEntry,
                 long inflatedLengthHint,
                 NestedJarHandler nestedJarHandler)
          throws java.io.IOException

Constructor for toplevel file slice.

Parameters:

path - the path

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

Throws:

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

PathSlice

public PathSlice(java.nio.file.Path path,
                 boolean isDeflatedZipEntry,
                 long inflatedLengthHint,
                 NestedJarHandler nestedJarHandler,
                 boolean checkAccess)
          throws java.io.IOException

Constructor for toplevel file slice.

Parameters:

path - the path

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

checkAccess - whether it is needed to check read access and if it is a file

Throws:

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

PathSlice

public PathSlice(java.nio.file.Path path,
                 NestedJarHandler nestedJarHandler)
          throws java.io.IOException

Constructor for toplevel file slice.

Parameters:

path - the path

nestedJarHandler - the nested jar handler

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