Apache Commons Compress 1.26.0 · org.apache.commons.compress.archivers.zip.ZipLong

Modifier and Type	Field and Description
public static final ZipLong	AED_SIG Archive extra data record signature.
public static final ZipLong	CFH_SIG Central File Header Signature
public static final ZipLong	DD_SIG Data Descriptor signature.
public static final ZipLong	LFH_SIG Local File Header Signature
private static final long	serialVersionUID
public static final ZipLong	SINGLE_SEGMENT_SPLIT_MARKER Marks ZIP archives that were supposed to be split or spanned but only needed a single segment in then end (so are actually neither split nor spanned).
private final long	value
pack-priv static final ZipLong	ZIP64_MAGIC Value stored in size and similar fields if ZIP64 extensions are used.

Access	Constructor and Description
public	ZipLong(final byte[] the bytes to store as a ZipLong bytes) Constructs a new instance from bytes.
public	ZipLong(final byte[] the bytes to store as a ZipLong bytes, final int the offset to start offset) Creates instance from the four bytes starting at offset.
public	ZipLong(final int the int to store as a ZipLong value) create instance from a Java int.
public	ZipLong(final long the long to store as a ZipLong value) Creates instance from a number.

Method Summary

Modifier and Type	Method and Description
public Object	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public boolean	Returns: true if the objects are equal equals(final Object an object to compare o) Overrides java.lang.Object.equals. Override to make two instances with same value equal.
public static byte[]	Returns: value as four bytes in big-endian byte order getBytes(final long the value to convert value) Gets value as four bytes in big-endian byte order.
public byte[]	Returns: value as four bytes in big-endian order getBytes() Gets value as four bytes in big-endian byte order.
public int	Returns: value as int getIntValue() Gets value as a (signed) Java int
public static long	Returns: the corresponding Java long value getValue(final byte[] the array of bytes bytes) Helper method to get the value as a Java long from a four-byte array
public static long	Returns: the corresponding Java long value getValue(final byte[] the array of bytes bytes, final int the offset to start offset) Helper method to get the value as a Java long from four bytes starting at given array offset
public long	Returns: value as a long getValue() Gets value as Java long.
public int	Returns: the value stored in the ZipLong hashCode() Overrides java.lang.Object.hashCode. Override to make two instances with same value equal.
public static void	putLong(final long the Java long to convert to bytes value, final byte[] the output buffer buf, final int The offset within the output buffer of the first byte to be written. must be non-negative and no larger than `buf.length-4` offset) put the value as four bytes in big-endian byte order.
public void	putLong(final byte[] buf, final int offset)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: finalize getClass notify notifyAll wait wait wait

Field Detail

AED_SIG	back to summary
public static final ZipLong AED_SIG Archive extra data record signature. Since 1.5

AED_SIG

back to summary

public static final ZipLong AED_SIG

Archive extra data record signature.

Since: 1.5

CFH_SIG	back to summary
public static final ZipLong CFH_SIG Central File Header Signature

DD_SIG	back to summary
public static final ZipLong DD_SIG Data Descriptor signature. Actually, PKWARE uses this as marker for split/spanned archives and other archivers have started to use it as Data Descriptor signature (as well). Since 1.1

DD_SIG

back to summary

public static final ZipLong DD_SIG

Data Descriptor signature.

Actually, PKWARE uses this as marker for split/spanned archives and other archivers have started to use it as Data Descriptor signature (as well).

Since: 1.1

LFH_SIG	back to summary
public static final ZipLong LFH_SIG Local File Header Signature

serialVersionUID	back to summary
private static final long serialVersionUID

SINGLE_SEGMENT_SPLIT_MARKER	back to summary
public static final ZipLong SINGLE_SEGMENT_SPLIT_MARKER Marks ZIP archives that were supposed to be split or spanned but only needed a single segment in then end (so are actually neither split nor spanned). This is the "PK00" prefix found in some archives. Since 1.5

SINGLE_SEGMENT_SPLIT_MARKER

back to summary

public static final ZipLong SINGLE_SEGMENT_SPLIT_MARKER

Marks ZIP archives that were supposed to be split or spanned but only needed a single segment in then end (so are actually neither split nor spanned).

This is the "PK00" prefix found in some archives.

Since: 1.5

value	back to summary
private final long value

ZIP64_MAGIC	back to summary
pack-priv static final ZipLong ZIP64_MAGIC Value stored in size and similar fields if ZIP64 extensions are used. Since 1.3

ZIP64_MAGIC

back to summary

pack-priv static final ZipLong ZIP64_MAGIC

Value stored in size and similar fields if ZIP64 extensions are used.

Since: 1.3

Constructor Detail

ZipLong	back to summary
public ZipLong(final byte[] bytes) Constructs a new instance from bytes. Parameters bytes:byte[] the bytes to store as a ZipLong

ZipLong

back to summary

public ZipLong(final byte[] bytes)

Constructs a new instance from bytes.

Parameters

bytes:byte[]: the bytes to store as a ZipLong

ZipLong	back to summary
public ZipLong(final byte[] bytes, final int offset) Creates instance from the four bytes starting at offset. Parameters bytes:byte[] the bytes to store as a ZipLong offset:int the offset to start

ZipLong

back to summary

public ZipLong(final byte[] bytes, final int offset)

Creates instance from the four bytes starting at offset.

Parameters

bytes:byte[]: the bytes to store as a ZipLong
offset:int: the offset to start

ZipLong	back to summary
public ZipLong(final int value) create instance from a Java int. Parameters value:int the int to store as a ZipLong Since 1.15

ZipLong

back to summary

public ZipLong(final int value)

create instance from a Java int.

Parameters

value:int: the int to store as a ZipLong

Since

1.15

ZipLong	back to summary
public ZipLong(final long value) Creates instance from a number. Parameters value:long the long to store as a ZipLong

ZipLong

back to summary

public ZipLong(final long value)

Creates instance from a number.

Parameters

value:long: the long to store as a ZipLong

Method Detail

clone back to summary

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:Object a clone of this instance. Annotations @Override

public Object clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object

a clone of this instance.

Annotations

@Override

equals	back to summary
public boolean equals(final Object o) Overrides java.lang.Object.equals. Override to make two instances with same value equal. Parameters o:Object an object to compare Returns:boolean true if the objects are equal Annotations @Override

equals

back to summary

public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Override to make two instances with same value equal.

Parameters

o:Object: an object to compare

Returns:boolean

true if the objects are equal

Annotations

@Override

getBytes	back to summary
public static byte[] getBytes(final long value) Gets value as four bytes in big-endian byte order. Parameters value:long the value to convert Returns:byte[] value as four bytes in big-endian byte order

getBytes

back to summary

public static byte[] getBytes(final long value)

Gets value as four bytes in big-endian byte order.

Parameters

value:long: the value to convert

Returns:byte[]

value as four bytes in big-endian byte order

getBytes	back to summary
public byte[] getBytes() Gets value as four bytes in big-endian byte order. Returns:byte[] value as four bytes in big-endian order

getBytes

back to summary

public byte[] getBytes()

Gets value as four bytes in big-endian byte order.

Returns:byte[]: value as four bytes in big-endian order

getIntValue	back to summary
public int getIntValue() Gets value as a (signed) Java int Returns:int value as int Since 1.15

getIntValue

back to summary

public int getIntValue()

Gets value as a (signed) Java int

Returns:int: value as int
Since: 1.15

getValue	back to summary
public static long getValue(final byte[] bytes) Helper method to get the value as a Java long from a four-byte array Parameters bytes:byte[] the array of bytes Returns:long the corresponding Java long value

getValue

back to summary

public static long getValue(final byte[] bytes)

Helper method to get the value as a Java long from a four-byte array

Parameters

bytes:byte[]: the array of bytes

Returns:long

the corresponding Java long value

getValue	back to summary
public static long getValue(final byte[] bytes, final int offset) Helper method to get the value as a Java long from four bytes starting at given array offset Parameters bytes:byte[] the array of bytes offset:int the offset to start Returns:long the corresponding Java long value

getValue

back to summary

public static long getValue(final byte[] bytes, final int offset)

Helper method to get the value as a Java long from four bytes starting at given array offset

Parameters

bytes:byte[]: the array of bytes
offset:int: the offset to start

Returns:long

the corresponding Java long value

getValue	back to summary
public long getValue() Gets value as Java long. Returns:long value as a long

getValue

back to summary

public long getValue()

Gets value as Java long.

Returns:long: value as a long

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Override to make two instances with same value equal. Returns:int the value stored in the ZipLong Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Override to make two instances with same value equal.

Returns:int

the value stored in the ZipLong

Annotations

@Override

putLong back to summary

putLong	back to summary
public static void putLong(final long value, final byte[] buf, final int offset) put the value as four bytes in big-endian byte order. Parameters value:long the Java long to convert to bytes buf:byte[] the output buffer offset:int The offset within the output buffer of the first byte to be written. must be non-negative and no larger than `buf.length-4`

public static void putLong(final long value, final byte[] buf, final int offset)

put the value as four bytes in big-endian byte order.

Parameters

value:long: the Java long to convert to bytes
buf:byte[]: the output buffer
offset:int: The offset within the output buffer of the first byte to be written. must be non-negative and no larger than buf.length-4

putLong	back to summary
public void putLong(final byte[] buf, final int offset)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public final Class ZipLong

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail