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

public Class ArraySlice

extends Slice
Class Inheritance
Imports
java.io.IOException, .InputStream, java.util.Arrays, nonapi.io.github.classgraph.fastzipfilereader.NestedJarHandler, nonapi.io.github.classgraph.fileslice.reader.RandomAccessArrayReader, .RandomAccessReader

A byte array slice.

Field Summary

Modifier and TypeField and Description
public byte[]
arr

The wrapped byte array.

Inherited from nonapi.io.github.classgraph.fileslice.Slice:
inflatedLengthHintisDeflatedZipEntrynestedJarHandlerparentSlicesliceLengthsliceStartPos

Constructor Summary

AccessConstructor and Description
private
ArraySlice(final ArraySlice
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 an array as a slice.

public
ArraySlice(final byte[]
the array containing the slice.
arr
,
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 whole array as a slice.

Method Summary

Modifier and TypeMethod and Description
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.

Return a new random access reader.

public Slice

Returns:

the slice
slice
(final long
the offset relative to the start of this slice to use as the start of the sub-slice.
offset
,
final long
the length of the sub-slice.
length
,
final boolean
the is 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 this slice to form a sub-slice.

Inherited from nonapi.io.github.classgraph.fileslice.Slice:
closeloadAsStringopenopenread

Field Detail

arrback to summary
public byte[] arr

The wrapped byte array.

Constructor Detail

ArraySliceback to summary
private ArraySlice(final ArraySlice parentSlice, final long offset, final long length, final boolean isDeflatedZipEntry, final long inflatedLengthHint, final NestedJarHandler nestedJarHandler)

Constructor for treating a range of an array as a slice.

Parameters
parentSlice:ArraySlice

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

ArraySliceback to summary
public ArraySlice(final byte[] arr, final boolean isDeflatedZipEntry, final long inflatedLengthHint, final NestedJarHandler nestedJarHandler)

Constructor for treating a whole array as a slice.

Parameters
arr:byte[]

the array containing the 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

Method Detail

equalsback 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
hashCodeback 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
loadback 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.
randomAccessReaderback to summary
public RandomAccessReader randomAccessReader()

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

Return a new random access reader.

Returns:RandomAccessReader

the random access reader

Annotations
@Override
sliceback 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 this slice to form a sub-slice.

Parameters
offset:long

the offset relative to the start of this slice to use as the start of the sub-slice.

length:long

the length of the sub-slice.

isDeflatedZipEntry:boolean

the is 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