org.apache.commons.compress.archivers.zip

Class ZipShort

java.lang.Object

org.apache.commons.compress.archivers.zip.ZipShort

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public final class ZipShort
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Utility class that represents a two byte integer with conversion rules for the little-endian byte order of ZIP files.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ZipShort	ZERO ZipShort with a value of 0.

Constructor Summary

Constructors

Constructor and Description
ZipShort(byte[] bytes) Constructs a new instance from bytes.
ZipShort(byte[] bytes, int offset) Constructs a new instance from the two bytes starting at offset.
ZipShort(int value) Constructs a new instance from a number.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
boolean	equals(java.lang.Object o) Override to make two instances with same value equal.
byte[]	getBytes() Gets value as two bytes in big-endian byte order.
static byte[]	getBytes(int value) Gets value as two bytes in big-endian byte order.
int	getValue() Gets value as Java int.
static int	getValue(byte[] bytes) Helper method to get the value as a Java int from a two-byte array
static int	getValue(byte[] bytes, int offset) Helper method to get the value as a Java int from two bytes starting at given array offset
int	hashCode() Override to make two instances with same value equal.
static void	putShort(int value, byte[] buf, int offset) put the value as two bytes in big-endian byte order.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ZERO

public static final ZipShort ZERO

ZipShort with a value of 0.

Since:

1.14

Constructor Detail

ZipShort

public ZipShort(byte[] bytes)

Constructs a new instance from bytes.

Parameters:

bytes - the bytes to store as a ZipShort

ZipShort

public ZipShort(byte[] bytes,
                int offset)

Constructs a new instance from the two bytes starting at offset.

Parameters:

bytes - the bytes to store as a ZipShort

offset - the offset to start

ZipShort

public ZipShort(int value)

Constructs a new instance from a number.

Parameters:

value - the int to store as a ZipShort

Method Detail

getBytes

public static byte[] getBytes(int value)

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

Parameters:

value - the Java int to convert to bytes

Returns:

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

getValue

public static int getValue(byte[] bytes)

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

Parameters:

bytes - the array of bytes

Returns:

the corresponding Java int value

getValue

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

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

Parameters:

bytes - the array of bytes

offset - the offset to start

Returns:

the corresponding Java int value

putShort

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

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

Parameters:

value - the Java int to convert to bytes

buf - the output buffer

offset - The offset within the output buffer of the first byte to be written. must be non-negative and no larger than buf.length-2

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Override to make two instances with same value equal.

Overrides:

equals in class java.lang.Object

Parameters:

o - an object to compare

Returns:

true if the objects are equal

getBytes

public byte[] getBytes()

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

Returns:

the value as a two byte array in big-endian byte order

getValue

public int getValue()

Gets value as Java int.

Returns:

value as a Java int

hashCode

public int hashCode()

Override to make two instances with same value equal.

Overrides:

hashCode in class java.lang.Object

Returns:

the value stored in the ZipShort

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object