Top Description Fields Constructors Methods
nonapi.io.github.classgraph.fastzipfilereader

pack-priv Class PhysicalZipFile

extends Object
Class Inheritance
Imports
java.io.File, .IOException, .InputStream, java.nio.channels.FileChannel, java.nio.file.Path, java.util.Objects, nonapi.io.github.classgraph.fileslice.ArraySlice, .FileSlice, .PathSlice, .Slice, nonapi.io.github.classgraph.utils.FastPathResolver, .FileUtils, .LogNode

A physical zipfile, which is mmap'd using a FileChannel.

Field Summary

Modifier and TypeField and Description
private File
file

The File backing this PhysicalZipFile, if any.

private int
hashCode

The cached hashCode.

pack-priv NestedJarHandler
nestedJarHandler

The nested jar handler.

private Path
path

The Path backing this PhysicalZipFile, if any.

private final String
pathStr

The path to the zipfile.

pack-priv Slice
slice

The Slice for the zipfile.

Constructor Summary

AccessConstructor and Description
pack-priv
PhysicalZipFile(final File
the file
file
,
final NestedJarHandler
the nested jar handler
nestedJarHandler
,
final LogNode
the log
log
)

Construct a PhysicalZipFile from a file on disk.

pack-priv
PhysicalZipFile(final Path
the path
path
,
final NestedJarHandler
the nested jar handler
nestedJarHandler
,
final LogNode
the log
log
)

Construct a PhysicalZipFile from a Path.

pack-priv
PhysicalZipFile(final byte[]
the array containing the zipfile.
arr
,
final File
the outermost file
outermostFile
,
final String
the path
pathStr
,
final NestedJarHandler
the nested jar handler
nestedJarHandler
)

Construct a PhysicalZipFile from a byte array.

pack-priv
PhysicalZipFile(final InputStream
the input stream
inputStream
,
final long
The number of bytes to read in inputStream, or -1 if unknown.
inputStreamLengthHint
,
final String
the source URL the InputStream was opened from, or the zip entry path of this entry in the parent zipfile
pathStr
,
final NestedJarHandler
the nested jar handler
nestedJarHandler
,
final LogNode
the log
log
)

Construct a PhysicalZipFile by reading from the InputStream to an array in RAM, or spill to disk if the InputStream is too long.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(final Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

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

public File

Returns:

the File for the outermost jar file of this PhysicalZipFile, or null if this file was downloaded from a URL directly to RAM, or is backed by a Path.
getFile
()

Get the File for the outermost jar file of this PhysicalZipFile.

public Path

Returns:

the Path for the outermost jar file of this PhysicalZipFile, or null if this file was downloaded from a URL directly to RAM, or is backed by a File.
getPath
()

Get the Path for the outermost jar file of this PhysicalZipFile.

public String

Returns:

the path for this PhysicalZipFile, which is the file path, if it is file-backed, or a compound nested jar path, if it is memory-backed.
getPathStr
()

Get the path for this PhysicalZipFile, which is the file path, if it is file-backed, or a compound nested jar path, if it is memory-backed.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public long

Returns:

the length of the mapped file
length
()

Get the length of the mapped file, or the initial remaining bytes in the wrapped ByteBuffer if a buffer was wrapped.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

fileback to summary
private File file

The File backing this PhysicalZipFile, if any.

hashCodeback to summary
private int hashCode

The cached hashCode.

nestedJarHandlerback to summary
pack-priv NestedJarHandler nestedJarHandler

The nested jar handler.

pathback to summary
private Path path

The Path backing this PhysicalZipFile, if any.

pathStrback to summary
private final String pathStr

The path to the zipfile.

sliceback to summary
pack-priv Slice slice

The Slice for the zipfile.

Constructor Detail

PhysicalZipFileback to summary
pack-priv PhysicalZipFile(final File file, final NestedJarHandler nestedJarHandler, final LogNode log) throws IOException

Construct a PhysicalZipFile from a file on disk.

Parameters
file:File

the file

nestedJarHandler:NestedJarHandler

the nested jar handler

log:LogNode

the log

Exceptions
IOException:
if an I/O exception occurs.
PhysicalZipFileback to summary
pack-priv PhysicalZipFile(final Path path, final NestedJarHandler nestedJarHandler, final LogNode log) throws IOException

Construct a PhysicalZipFile from a Path.

Parameters
path:Path

the path

nestedJarHandler:NestedJarHandler

the nested jar handler

log:LogNode

the log

Exceptions
IOException:
if an I/O exception occurs.
PhysicalZipFileback to summary
pack-priv PhysicalZipFile(final byte[] arr, final File outermostFile, final String pathStr, final NestedJarHandler nestedJarHandler) throws IOException

Construct a PhysicalZipFile from a byte array.

Parameters
arr:byte[]

the array containing the zipfile.

outermostFile:File

the outermost file

pathStr:String

the path

nestedJarHandler:NestedJarHandler

the nested jar handler

Exceptions
IOException:
if an I/O exception occurs.
PhysicalZipFileback to summary
pack-priv PhysicalZipFile(final InputStream inputStream, final long inputStreamLengthHint, final String pathStr, final NestedJarHandler nestedJarHandler, final LogNode log) throws IOException

Construct a PhysicalZipFile by reading from the InputStream to an array in RAM, or spill to disk if the InputStream is too long.

Parameters
inputStream:InputStream

the input stream

inputStreamLengthHint:long

The number of bytes to read in inputStream, or -1 if unknown.

pathStr:String

the source URL the InputStream was opened from, or the zip entry path of this entry in the parent zipfile

nestedJarHandler:NestedJarHandler

the nested jar handler

log:LogNode

the log

Exceptions
IOException:
if an I/O exception occurs.

Method Detail

equalsback to summary
public boolean equals(final Object o)

Overrides java.lang.Object.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
getFileback to summary
public File getFile()

Get the File for the outermost jar file of this PhysicalZipFile.

Returns:File

the File for the outermost jar file of this PhysicalZipFile, or null if this file was downloaded from a URL directly to RAM, or is backed by a Path.

getPathback to summary
public Path getPath()

Get the Path for the outermost jar file of this PhysicalZipFile.

Returns:Path

the Path for the outermost jar file of this PhysicalZipFile, or null if this file was downloaded from a URL directly to RAM, or is backed by a File.

getPathStrback to summary
public String getPathStr()

Get the path for this PhysicalZipFile, which is the file path, if it is file-backed, or a compound nested jar path, if it is memory-backed.

Returns:String

the path for this PhysicalZipFile, which is the file path, if it is file-backed, or a compound nested jar path, if it is memory-backed.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.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
lengthback to summary
public long length()

Get the length of the mapped file, or the initial remaining bytes in the wrapped ByteBuffer if a buffer was wrapped.

Returns:long

the length of the mapped file

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override