com.mucommander.file.impl.zip.provider
Class ZipShort

java.lang.Object
  com.mucommander.file.impl.zip.provider.ZipShort

All Implemented Interfaces:

java.lang.Cloneable

public final class ZipShort
extends java.lang.Object
implements java.lang.Cloneable

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

--------------------------------------------------------------------------------------------------------------

This class is based off the org.apache.tools.zip package of the Apache Ant project. The Ant code has been modified under the terms of the Apache License which you can find in the bundled muCommander license file. It was forked at version 1.7.0 of Ant.

Author:

Apache Ant, Maxence Bernard

Constructor Summary

ZipShort(byte[] bytes)
Create instance from bytes.

ZipShort(byte[] bytes, int offset)
Create instance from the two bytes starting at offset.

ZipShort(int value)
Create instance from a number.

Method Summary

boolean	equals(java.lang.Object o) Override to make two instances with same value equal.
byte[]	getBytes() Get value as two bytes in big endian byte order.
static byte[]	getBytes(int value) Converts the given short value as two bytes in big endian byte order.
static byte[]	getBytes(int value, byte[] result) Converts the given short value as two bytes in big endian byte order.
static byte[]	getBytes(int value, byte[] result, int off) Converts the given short value as two bytes in big endian byte order.
int	getValue() Get 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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ZipShort

public ZipShort(int value)

Create instance from a number.

Parameters:

value - the int to store as a ZipShort

ZipShort

public ZipShort(byte[] bytes)

Create instance from bytes.

Parameters:

bytes - the bytes to store as a ZipShort

ZipShort

public ZipShort(byte[] bytes,
                int offset)

Create instance from the two bytes starting at offset.

Parameters:

bytes - the bytes to store as a ZipShort

offset - the offset to start

Method Detail

getBytes

public byte[] getBytes()

Get value as two bytes in big endian byte order.

Returns:

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

getValue

public int getValue()

Get value as Java int.

Returns:

value as a Java int

getBytes

public static byte[] getBytes(int value)

Converts the given short value as two bytes in big endian byte order.

Parameters:

value - the short value (stored as an int) to convert

Returns:

the converted value as a byte array in big endian byte order

getBytes

public static byte[] getBytes(int value,
                              byte[] result)

Converts the given short value as two bytes in big endian byte order. The specified byte array is used to store the result, starting at offset 0. The returned byte array is the same as the given one.

Parameters:

value - the short value (stored as an int) to convert

result - the byte array in which to store the value in big endian byte order

Returns:

the converted value as a byte array in big endian byte order

getBytes

public static byte[] getBytes(int value,
                              byte[] result,
                              int off)

Converts the given short value as two bytes in big endian byte order. The specified byte array is used to store the result, starting at the given offset. The returned byte array is the same as the given one.

Parameters:

value - the short value (stored as an int) to convert

result - the byte array in which to store the value in big endian byte order

off - offset at which to start writing the result in the array

Returns:

the converted value as a byte array in big endian byte order

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 correspondanding java int value

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 correspondanding java int value

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

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