ClassGraph 4.8.179 · nonapi.io.github.classgraph.fileslice.PathSlice

Modifier and Type	Field and Description
private FileChannel	fileChannel The `FileChannel` opened on the `Path`.
private final long	fileLength The file length.
private final AtomicBoolean	isClosed True if `close` has been called.
private final boolean	isTopLevelFileSlice True if this is a top level file slice.
public final Path	path The `Path`.

Access	Constructor and Description
private	PathSlice(final PathSlice the parent slice parentSlice, final long the offset of the sub-slice within the parent slice offset, final long the length of the sub-slice length, final boolean true if this is a deflated zip entry isDeflatedZipEntry, final long the uncompressed size of a deflated zip entry, or -1 if unknown, or 0 of this is not a deflated zip entry. inflatedLengthHint, final NestedJarHandler the nested jar handler nestedJarHandler) Constructor for treating a range of a file as a slice.
public	PathSlice(final Path the path path, final boolean true if this is a deflated zip entry isDeflatedZipEntry, final long the uncompressed size of a deflated zip entry, or -1 if unknown, or 0 of this is not a deflated zip entry. inflatedLengthHint, final NestedJarHandler the nested jar handler nestedJarHandler) Constructor for toplevel file slice.
public	PathSlice(final Path the path path, final boolean true if this is a deflated zip entry isDeflatedZipEntry, final long the uncompressed size of a deflated zip entry, or -1 if unknown, or 0 of this is not a deflated zip entry. inflatedLengthHint, final NestedJarHandler the nested jar handler nestedJarHandler, final boolean whether it is needed to check read access and if it is a file checkAccess) Constructor for toplevel file slice.
public	PathSlice(final Path the path path, final NestedJarHandler the nested jar handler nestedJarHandler) Constructor for toplevel file slice.

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides nonapi.io.github.classgraph.fileslice.Slice.close. Implements java.io.Closeable.close. Close the slice.
public boolean	equals(final Object the reference object with which to compare. o) Overrides nonapi.io.github.classgraph.fileslice.Slice.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides nonapi.io.github.classgraph.fileslice.Slice.hashCode. Returns a hash code value for this object.
public byte[]	Returns: the byte[] load() Implements abstract nonapi.io.github.classgraph.fileslice.Slice.load. Load the slice as a byte array.
public RandomAccessReader	Returns: the random access reader randomAccessReader() Implements abstract nonapi.io.github.classgraph.fileslice.Slice.randomAccessReader. Read directly from FileChannel (slow path, but handles >2GB).
public ByteBuffer	Returns: the byte buffer read() Overrides nonapi.io.github.classgraph.fileslice.Slice.read. Read the slice into a `ByteBuffer` (or memory-map the slice to a `MappedByteBuffer`, if `ClassGraph#enableMemoryMapping()` was called.)
public Slice	Returns: the slice slice(final long the offset of the sub-slice within the parent slice offset, final long the length of the sub-slice length, final boolean true if this is a deflated zip entry isDeflatedZipEntry, final long the uncompressed size of a deflated zip entry, or -1 if unknown, or 0 of this is not a deflated zip entry. inflatedLengthHint) Implements abstract nonapi.io.github.classgraph.fileslice.Slice.slice. Slice the file.

Inherited from nonapi.io.github.classgraph.fileslice.Slice:: loadAsString open open

Field Detail

fileChannel	back to summary
private FileChannel fileChannel The `FileChannel` opened on the `Path`.

fileLength	back to summary
private final long fileLength The file length.

isClosed	back to summary
private final AtomicBoolean isClosed True if `close` has been called.

isTopLevelFileSlice	back to summary
private final boolean isTopLevelFileSlice True if this is a top level file slice.

path	back to summary
public final Path path The `Path`.

Constructor Detail

PathSlice	back to summary
private PathSlice(final PathSlice parentSlice, final long offset, final long length, final boolean isDeflatedZipEntry, final long inflatedLengthHint, final NestedJarHandler nestedJarHandler) Constructor for treating a range of a file as a slice. Parameters parentSlice:PathSlice the parent slice offset:long the offset of the sub-slice within the parent slice length:long the length of the sub-slice isDeflatedZipEntry:boolean true if this is a deflated zip entry inflatedLengthHint:long the uncompressed size of a deflated zip entry, or -1 if unknown, or 0 of this is not a deflated zip entry. nestedJarHandler:NestedJarHandler the nested jar handler

PathSlice

back to summary

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

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

Parameters

parentSlice:PathSlice: the parent slice
offset:long: the offset of the sub-slice within the parent slice
length:long: the length of the sub-slice
isDeflatedZipEntry:boolean: true if this is a deflated zip entry
inflatedLengthHint:long: the uncompressed size of a deflated zip entry, or -1 if unknown, or 0 of this is not a deflated zip entry.
nestedJarHandler:NestedJarHandler: the nested jar handler

PathSlice	back to summary
public PathSlice(final Path path, final boolean isDeflatedZipEntry, final long inflatedLengthHint, final NestedJarHandler nestedJarHandler) throws IOException Constructor for toplevel file slice. Parameters path:Path the path isDeflatedZipEntry:boolean true if this is a deflated zip entry inflatedLengthHint:long the uncompressed size of a deflated zip entry, or -1 if unknown, or 0 of this is not a deflated zip entry. nestedJarHandler:NestedJarHandler the nested jar handler Exceptions IOException: if the file cannot be opened.

PathSlice

back to summary

public PathSlice(final Path path, final boolean isDeflatedZipEntry, final long inflatedLengthHint, final NestedJarHandler nestedJarHandler) throws IOException

Constructor for toplevel file slice.

Parameters

path:Path: the path
isDeflatedZipEntry:boolean: true if this is a deflated zip entry
inflatedLengthHint:long: the uncompressed size of a deflated zip entry, or -1 if unknown, or 0 of this is not a deflated zip entry.
nestedJarHandler:NestedJarHandler: the nested jar handler

Exceptions

IOException:: if the file cannot be opened.

PathSlice	back to summary
public PathSlice(final Path path, final boolean isDeflatedZipEntry, final long inflatedLengthHint, final NestedJarHandler nestedJarHandler, final boolean checkAccess) throws IOException Constructor for toplevel file slice. Parameters path:Path the path isDeflatedZipEntry:boolean true if this is a deflated zip entry inflatedLengthHint:long the uncompressed size of a deflated zip entry, or -1 if unknown, or 0 of this is not a deflated zip entry. nestedJarHandler:NestedJarHandler the nested jar handler checkAccess:boolean whether it is needed to check read access and if it is a file Exceptions IOException: if the file cannot be opened.

PathSlice

back to summary

public PathSlice(final Path path, final boolean isDeflatedZipEntry, final long inflatedLengthHint, final NestedJarHandler nestedJarHandler, final boolean checkAccess) throws IOException

Constructor for toplevel file slice.

Parameters

path:Path: the path
isDeflatedZipEntry:boolean: true if this is a deflated zip entry
inflatedLengthHint:long: the uncompressed size of a deflated zip entry, or -1 if unknown, or 0 of this is not a deflated zip entry.
nestedJarHandler:NestedJarHandler: the nested jar handler
checkAccess:boolean: whether it is needed to check read access and if it is a file

Exceptions

IOException:: if the file cannot be opened.

PathSlice	back to summary
public PathSlice(final Path path, final NestedJarHandler nestedJarHandler) throws IOException Constructor for toplevel file slice. Parameters path:Path the path nestedJarHandler:NestedJarHandler the nested jar handler Exceptions IOException: if the file cannot be opened.

PathSlice

back to summary

public PathSlice(final Path path, final NestedJarHandler nestedJarHandler) throws IOException

Constructor for toplevel file slice.

Parameters

path:Path: the path
nestedJarHandler:NestedJarHandler: the nested jar handler

Exceptions

IOException:: if the file cannot be opened.

Method Detail

close back to summary

close	back to summary
public void close() Overrides nonapi.io.github.classgraph.fileslice.Slice.close. Implements java.io.Closeable.close. Close the slice. Unmaps any backing `MappedByteBuffer`. Annotations @Override

public void close()

Overrides nonapi.io.github.classgraph.fileslice.Slice.close.

Implements java.io.Closeable.close.

Close the slice. Unmaps any backing MappedByteBuffer.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(final Object o) Overrides nonapi.io.github.classgraph.fileslice.Slice.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object o)

Overrides nonapi.io.github.classgraph.fileslice.Slice.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides nonapi.io.github.classgraph.fileslice.Slice.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides nonapi.io.github.classgraph.fileslice.Slice.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

load	back to summary
public byte[] load() throws IOException Implements abstract nonapi.io.github.classgraph.fileslice.Slice.load. Load the slice as a byte array. Returns:byte[] the byte[] Annotations @Override Exceptions IOException: Signals that an I/O exception has occurred.

load

back to summary

public byte[] load() throws IOException

Implements abstract nonapi.io.github.classgraph.fileslice.Slice.load.

Load the slice as a byte array.

Returns:byte[]

the byte[]

Annotations

@Override

Exceptions

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

randomAccessReader	back to summary
public RandomAccessReader randomAccessReader() Implements abstract nonapi.io.github.classgraph.fileslice.Slice.randomAccessReader. Read directly from FileChannel (slow path, but handles >2GB). Returns:RandomAccessReader the random access reader Annotations @Override

randomAccessReader

back to summary

public RandomAccessReader randomAccessReader()

Implements abstract nonapi.io.github.classgraph.fileslice.Slice.randomAccessReader.

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

Returns:RandomAccessReader

the random access reader

Annotations

@Override

read back to summary

read	back to summary
public ByteBuffer read() throws IOException Overrides nonapi.io.github.classgraph.fileslice.Slice.read. Read the slice into a `ByteBuffer` (or memory-map the slice to a `MappedByteBuffer`, if `ClassGraph#enableMemoryMapping()` was called.) Returns:ByteBuffer the byte buffer Annotations @Override Exceptions IOException: Signals that an I/O exception has occurred.

public ByteBuffer read() throws IOException

Overrides nonapi.io.github.classgraph.fileslice.Slice.read.

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

Returns:ByteBuffer

the byte buffer

Annotations

@Override

Exceptions

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

slice	back to summary
public Slice slice(final long offset, final long length, final boolean isDeflatedZipEntry, final long inflatedLengthHint) Implements abstract nonapi.io.github.classgraph.fileslice.Slice.slice. Slice the file. Parameters offset:long the offset of the sub-slice within the parent slice length:long the length of the sub-slice isDeflatedZipEntry:boolean true if this is a deflated zip entry inflatedLengthHint:long the uncompressed size of a deflated zip entry, or -1 if unknown, or 0 of this is not a deflated zip entry. Returns:Slice the slice Annotations @Override

slice

back to summary

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

Implements abstract nonapi.io.github.classgraph.fileslice.Slice.slice.

Slice the file.

Parameters

offset:long: the offset of the sub-slice within the parent slice
length:long: the length of the sub-slice
isDeflatedZipEntry:boolean: true if this is a deflated zip entry
inflatedLengthHint:long: the uncompressed size of a deflated zip entry, or -1 if unknown, or 0 of this is not a deflated zip entry.

Returns:Slice

the slice

Annotations

@Override

public Class PathSlice

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail