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

Modifier and Type	Field and Description
private static final long	serialVersionUID
private final int	value
public static final ZipShort	ZERO ZipShort with a value of 0.

Access	Constructor and Description
public	ZipShort(final byte[] the bytes to store as a ZipShort bytes) Constructs a new instance from bytes.
public	ZipShort(final byte[] the bytes to store as a ZipShort bytes, final int the offset to start offset) Constructs a new instance from the two bytes starting at offset.
public	ZipShort(final int the int to store as a ZipShort value) Constructs a new 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: the converted int as a byte array in big-endian byte order getBytes(final int the Java int to convert to bytes value) Gets value as two bytes in big-endian byte order.
public byte[]	Returns: the value as a two byte array in big-endian byte order getBytes() Gets value as two bytes in big-endian byte order.
public static int	Returns: the corresponding Java int value getValue(final byte[] the array of bytes bytes) Helper method to get the value as a Java int from a two-byte array
public static int	Returns: the corresponding Java int 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 int from two bytes starting at given array offset
public int	Returns: value as a Java int getValue() Gets value as Java int.
public int	Returns: the value stored in the ZipShort hashCode() Overrides java.lang.Object.hashCode. Override to make two instances with same value equal.
public static void	putShort(final int the Java int 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-2` offset) put the value as two bytes in big-endian byte order.
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

serialVersionUID	back to summary
private static final long serialVersionUID

value	back to summary
private final int value

ZERO	back to summary
public static final ZipShort ZERO ZipShort with a value of 0. Since 1.14

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

ZipShort	back to summary
public ZipShort(final byte[] bytes, final int offset) Constructs a new instance from the two bytes starting at offset. Parameters bytes:byte[] the bytes to store as a ZipShort offset:int the offset to start

ZipShort	back to summary
public ZipShort(final int value) Constructs a new instance from a number. Parameters value:int the int to store as a ZipShort

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 int value) Gets value as two bytes in big-endian byte order. Parameters value:int the Java int to convert to bytes Returns:byte[] the converted int as a byte array in big-endian byte order

getBytes

back to summary

public static byte[] getBytes(final int value)

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

Parameters

value:int: the Java int to convert to bytes

Returns:byte[]

the converted int as a byte array in big-endian byte order

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

getBytes

back to summary

public byte[] getBytes()

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

Returns:byte[]: the value as a two byte array in big-endian byte order

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

getValue

back to summary

public static int getValue(final byte[] bytes)

Helper method to get the value as a Java int from a two-byte array

Parameters

bytes:byte[]: the array of bytes

Returns:int

the corresponding Java int value

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

getValue

back to summary

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

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

Parameters

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

Returns:int

the corresponding Java int value

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

getValue

back to summary

public int getValue()

Gets value as Java int.

Returns:int: value as a Java int

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 ZipShort 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 ZipShort

Annotations

@Override

putShort back to summary

putShort	back to summary
public static void putShort(final int value, final byte[] buf, final int offset) put the value as two bytes in big-endian byte order. Parameters value:int the Java int 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-2`

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

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

Parameters

value:int: the Java int 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-2

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 ZipShort

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail