EncodingTools

java.lang.Object
- rescuecore2.misc.EncodingTools

```
public final class EncodingTools
extends java.lang.Object
```
A bunch of useful tools for encoding and decoding things like integers.

Field Summary

Fields
Modifier and Type Field and Description

static int INT_32_SIZE
The size of an INT_32 in bytes.

Fields
Modifier and Type	Field and Description
`static int`	`INT_32_SIZE` The size of an INT_32 in bytes.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`readBoolean(byte[] in)` Read a boolean from a byte array.
`static boolean`	`readBoolean(byte[] in, int offset)` Read a boolean from a byte array.
`static boolean`	`readBoolean(java.io.DataInput in)` Read a boolean from a DataInput.
`static boolean`	`readBoolean(java.io.InputStream in)` Read a boolean from an input stream.
`static byte[]`	`readBytes(int size, java.io.DataInput in)` Read a fixed number of bytes from a DataInput into an array.
`static byte[]`	`readBytes(int size, java.io.InputStream in)` Read a fixed number of bytes from an InputStream into an array.
`static double`	`readDouble(byte[] in)` Read a double from a byte array.
`static double`	`readDouble(byte[] in, int offset)` Read a double from a byte array.
`static double`	`readDouble(java.io.DataInput in)` Read a double from a DataInput.
`static double`	`readDouble(java.io.InputStream in)` Read a double from an input stream.
`static Entity`	`readEntity(java.io.DataInput in)` Read an entity from a DataInput.
`static Entity`	`readEntity(java.io.InputStream in)` Read an entity from a stream.
`static float`	`readFloat32(java.io.DataInput in)` Read a 32-bit float from a DataInput.
`static float`	`readFloat32(java.io.InputStream in)` Read a 32-bit float from an input stream, big-endian style.
`static int`	`readInt32(byte[] in)` Read a 32-bit integer from a byte array, big-endian style.
`static int`	`readInt32(byte[] in, int offset)` Read a 32-bit integer from a byte array, big-endian style.
`static int`	`readInt32(java.io.DataInput in)` Read a 32-bit integer from a DataInput.
`static int`	`readInt32(java.io.InputStream in)` Read a 32-bit integer from an input stream, big-endian style.
`static int`	`readInt32LE(java.io.InputStream in)` Read a 32-bit integer from an input stream, little-endian style.
`static Message`	`readMessage(java.io.DataInput in)` Read a message from a DataInput.
`static Message`	`readMessage(java.io.InputStream in)` Read a message from a stream.
`static Property`	`readProperty(java.io.DataInput in)` Read a property from a DataInput.
`static Property`	`readProperty(java.io.InputStream in)` Read a property from a stream.
`static java.lang.String`	`readString(byte[] in)` Read a String from a byte array.
`static java.lang.String`	`readString(byte[] in, int offset)` Read a String from a byte array.
`static java.lang.String`	`readString(java.io.DataInput in)` Read a String from a DataInput.
`static java.lang.String`	`readString(java.io.InputStream in)` Read a String from an InputStream.
`static void`	`reallySkip(java.io.DataInput in, int count)` Call DataInput.skip until exactly `count` bytes have been skipped.
`static void`	`reallySkip(java.io.InputStream in, long count)` Call InputStream.skip until exactly `count` bytes have been skipped.
`static void`	`writeBoolean(boolean b, byte[] out, int offset)` Write a boolean to a byte array.
`static void`	`writeBoolean(boolean b, java.io.DataOutput out)` Write a boolean to a DataOutput.
`static void`	`writeBoolean(boolean b, java.io.OutputStream out)` Write a boolean to an OutputStream.
`static void`	`writeDouble(double d, byte[] out, int offset)` Write a double to a byte array.
`static void`	`writeDouble(double d, java.io.DataOutput out)` Write a double to a DataOutput.
`static void`	`writeDouble(double d, java.io.OutputStream out)` Write a double to an OutputStream.
`static void`	`writeEntity(Entity e, java.io.DataOutput out)` Write an entity to a DataOutput.
`static void`	`writeEntity(Entity e, java.io.OutputStream out)` Write an entity to a stream.
`static void`	`writeFloat32(float f, byte[] out, int offset)` Write a 32-bit float to a byte array, big-endian style.
`static void`	`writeFloat32(float f, java.io.DataOutput out)` Write a 32-bit float to a DataOutput, big-endian style.
`static void`	`writeFloat32(float f, java.io.OutputStream out)` Write a 32-bit float to an OutputStream, big-endian style.
`static void`	`writeInt32(int i, byte[] out, int offset)` Write a 32-bit integer to a byte array, big-endian style.
`static void`	`writeInt32(int i, java.io.DataOutput out)` Write a 32-bit integer to a DataOutput, big-endian style.
`static void`	`writeInt32(int i, java.io.OutputStream out)` Write a 32-bit integer to an OutputStream, big-endian style.
`static void`	`writeMessage(Message m, java.io.DataOutput out)` Write a message to a DataOutput.
`static void`	`writeMessage(Message m, java.io.OutputStream out)` Write a message to a stream.
`static void`	`writeProperty(Property p, java.io.DataOutput out)` Write a property to a DataOutput.
`static void`	`writeProperty(Property p, java.io.OutputStream out)` Write a property to a stream.
`static void`	`writeString(java.lang.String s, byte[] out, int offset)` Write a String to a byte array.
`static void`	`writeString(java.lang.String s, java.io.DataOutput out)` Write a String to a DataOutput.
`static void`	`writeString(java.lang.String s, java.io.OutputStream out)` Write a String to an OutputStream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INT_32_SIZE
```
public static final int INT_32_SIZE
```
    The size of an INT_32 in bytes.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - writeInt32
```
public static void writeInt32(int i,
                              java.io.OutputStream out)
                       throws java.io.IOException
```
    Write a 32-bit integer to an OutputStream, big-endian style.
    
    Parameters:
    
    i - The integer to write.
    
    out - The OutputStream to write it to.
    
    Throws:
    
    java.io.IOException - If the OutputStream blows up.
  - writeInt32
```
public static void writeInt32(int i,
                              java.io.DataOutput out)
                       throws java.io.IOException
```
    Write a 32-bit integer to a DataOutput, big-endian style.
    
    Parameters:
    
    i - The integer to write.
    
    out - The DataOutput to write it to.
    
    Throws:
    
    java.io.IOException - If the DataOutput blows up.
  - writeInt32
```
public static void writeInt32(int i,
                              byte[] out,
                              int offset)
```
    Write a 32-bit integer to a byte array, big-endian style.
    
    Parameters:
    
    i - The integer to write.
    
    out - The buffer to write it to.
    
    offset - Where in the buffer to write it.
  - readInt32
```
public static int readInt32(java.io.InputStream in)
                     throws java.io.IOException
```
    Read a 32-bit integer from an input stream, big-endian style.
    
    Parameters:
    
    in - The InputStream to read from.
    
    Returns:
    
    The next big-endian, 32-bit integer in the stream.
    
    Throws:
    
    java.io.IOException - If the InputStream blows up.
    
    java.io.EOFException - If the end of the stream is reached.
  - readInt32
```
public static int readInt32(java.io.DataInput in)
                     throws java.io.IOException
```
    Read a 32-bit integer from a DataInput.
    
    Parameters:
    
    in - The DataInput to read from.
    
    Returns:
    
    The next big-endian, 32-bit integer in the stream.
    
    Throws:
    
    java.io.IOException - If the DataInput blows up.
    
    java.io.EOFException - If the end of the stream is reached.
  - readInt32LE
```
public static int readInt32LE(java.io.InputStream in)
                       throws java.io.IOException
```
    Read a 32-bit integer from an input stream, little-endian style.
    
    Parameters:
    
    in - The InputStream to read from.
    
    Returns:
    
    The next little-endian, 32-bit integer in the stream.
    
    Throws:
    
    java.io.IOException - If the InputStream blows up.
    
    java.io.EOFException - If the end of the stream is reached.
  - readInt32
```
public static int readInt32(byte[] in,
                            int offset)
```
    Read a 32-bit integer from a byte array, big-endian style.
    
    Parameters:
    
    in - The buffer to read from.
    
    offset - Where to begin reading.
    
    Returns:
    
    The next big-endian, 32-bit integer in the buffer.
  - readInt32
```
public static int readInt32(byte[] in)
```
    Read a 32-bit integer from a byte array, big-endian style. This is equivalent to calling readInt32(in, 0).
    
    Parameters:
    
    in - The buffer to read from.
    
    Returns:
    
    The first big-endian, 32-bit integer in the buffer.
  - writeString
```
public static void writeString(java.lang.String s,
                               java.io.OutputStream out)
                        throws java.io.IOException
```
    Write a String to an OutputStream. Strings are always in UTF-8.
    
    Parameters:
    
    s - The String to write.
    
    out - The OutputStream to write to.
    
    Throws:
    
    java.io.IOException - If the OutputStream blows up.
  - writeString
```
public static void writeString(java.lang.String s,
                               java.io.DataOutput out)
                        throws java.io.IOException
```
    Write a String to a DataOutput. Strings are always in UTF-8.
    
    Parameters:
    
    s - The String to write.
    
    out - The DataOutput to write to.
    
    Throws:
    
    java.io.IOException - If the DataOutput blows up.
  - writeString
```
public static void writeString(java.lang.String s,
                               byte[] out,
                               int offset)
```
    Write a String to a byte array. Strings are always in UTF-8.
    
    Parameters:
    
    s - The String to write.
    
    out - The byte array to write to. Make sure it's big enough!
    
    offset - The index to start writing from.
  - readString
```
public static java.lang.String readString(java.io.InputStream in)
                                   throws java.io.IOException
```
    Read a String from an InputStream.
    
    Parameters:
    
    in - The InputStream to read.
    
    Returns:
    
    The string that was read.
    
    Throws:
    
    java.io.IOException - If the InputStream blows up.
    
    java.io.EOFException - If the end of the stream is reached.
  - readString
```
public static java.lang.String readString(java.io.DataInput in)
                                   throws java.io.IOException
```
    Read a String from a DataInput.
    
    Parameters:
    
    in - The DataInput to read.
    
    Returns:
    
    The string that was read.
    
    Throws:
    
    java.io.IOException - If the DataInput blows up.
    
    java.io.EOFException - If the end of the stream is reached.
  - readString
```
public static java.lang.String readString(byte[] in)
```
    Read a String from a byte array. This is equivalent to calling readString(in, 0).
    
    Parameters:
    
    in - The byte array to read.
    
    Returns:
    
    The string that was read.
  - readString
```
public static java.lang.String readString(byte[] in,
                                          int offset)
```
    Read a String from a byte array.
    
    Parameters:
    
    in - The byte array to read.
    
    offset - The index in the array to read from.
    
    Returns:
    
    The string that was read.
  - readBytes
```
public static byte[] readBytes(int size,
                               java.io.InputStream in)
                        throws java.io.IOException
```
    Read a fixed number of bytes from an InputStream into an array.
    
    Parameters:
    
    size - The number of bytes to read.
    
    in - The InputStream to read from.
    
    Returns:
    
    A new byte array containing the bytes.
    
    Throws:
    
    java.io.IOException - If the read operation fails.
  - readBytes
```
public static byte[] readBytes(int size,
                               java.io.DataInput in)
                        throws java.io.IOException
```
    Read a fixed number of bytes from a DataInput into an array.
    
    Parameters:
    
    size - The number of bytes to read.
    
    in - The DataInput to read from.
    
    Returns:
    
    A new byte array containing the bytes.
    
    Throws:
    
    java.io.IOException - If the read operation fails.
  - writeDouble
```
public static void writeDouble(double d,
                               java.io.OutputStream out)
                        throws java.io.IOException
```
    Write a double to an OutputStream.
    
    Parameters:
    
    d - The double to write.
    
    out - The OutputStream to write it to.
    
    Throws:
    
    java.io.IOException - If the OutputStream blows up.
  - writeDouble
```
public static void writeDouble(double d,
                               java.io.DataOutput out)
                        throws java.io.IOException
```
    Write a double to a DataOutput.
    
    Parameters:
    
    d - The double to write.
    
    out - The DataOutput to write it to.
    
    Throws:
    
    java.io.IOException - If the DataOutput blows up.
  - writeDouble
```
public static void writeDouble(double d,
                               byte[] out,
                               int offset)
```
    Write a double to a byte array.
    
    Parameters:
    
    d - The double to write.
    
    out - The buffer to write it to.
    
    offset - Where in the buffer to write it.
  - readDouble
```
public static double readDouble(java.io.InputStream in)
                         throws java.io.IOException
```
    Read a double from an input stream.
    
    Parameters:
    
    in - The InputStream to read from.
    
    Returns:
    
    The next double in the stream.
    
    Throws:
    
    java.io.IOException - If the InputStream blows up.
    
    java.io.EOFException - If the end of the stream is reached.
  - readDouble
```
public static double readDouble(java.io.DataInput in)
                         throws java.io.IOException
```
    Read a double from a DataInput.
    
    Parameters:
    
    in - The DataInput to read from.
    
    Returns:
    
    The next double in the stream.
    
    Throws:
    
    java.io.IOException - If the DataInput blows up.
    
    java.io.EOFException - If the end of the stream is reached.
  - readDouble
```
public static double readDouble(byte[] in,
                                int offset)
```
    Read a double from a byte array.
    
    Parameters:
    
    in - The buffer to read from.
    
    offset - Where to begin reading.
    
    Returns:
    
    The next double in the buffer.
  - readDouble
```
public static double readDouble(byte[] in)
```
    Read a double from a byte array. This is equivalent to calling readDouble(in, 0).
    
    Parameters:
    
    in - The buffer to read from.
    
    Returns:
    
    The first double in the buffer.
  - writeBoolean
```
public static void writeBoolean(boolean b,
                                java.io.OutputStream out)
                         throws java.io.IOException
```
    Write a boolean to an OutputStream.
    
    Parameters:
    
    b - The boolean to write.
    
    out - The OutputStream to write it to.
    
    Throws:
    
    java.io.IOException - If the OutputStream blows up.
  - writeBoolean
```
public static void writeBoolean(boolean b,
                                java.io.DataOutput out)
                         throws java.io.IOException
```
    Write a boolean to a DataOutput.
    
    Parameters:
    
    b - The boolean to write.
    
    out - The DataOutput to write it to.
    
    Throws:
    
    java.io.IOException - If the DataOutput blows up.
  - writeBoolean
```
public static void writeBoolean(boolean b,
                                byte[] out,
                                int offset)
```
    Write a boolean to a byte array.
    
    Parameters:
    
    b - The boolean to write.
    
    out - The buffer to write it to.
    
    offset - Where in the buffer to write it.
  - readBoolean
```
public static boolean readBoolean(java.io.InputStream in)
                           throws java.io.IOException
```
    Read a boolean from an input stream.
    
    Parameters:
    
    in - The InputStream to read from.
    
    Returns:
    
    The next boolean in the stream.
    
    Throws:
    
    java.io.IOException - If the InputStream blows up.
    
    java.io.EOFException - If the end of the stream is reached.
  - readBoolean
```
public static boolean readBoolean(java.io.DataInput in)
                           throws java.io.IOException
```
    Read a boolean from a DataInput.
    
    Parameters:
    
    in - The DataInput to read from.
    
    Returns:
    
    The next boolean in the stream.
    
    Throws:
    
    java.io.IOException - If the DataInput blows up.
    
    java.io.EOFException - If the end of the stream is reached.
  - readBoolean
```
public static boolean readBoolean(byte[] in,
                                  int offset)
```
    Read a boolean from a byte array.
    
    Parameters:
    
    in - The buffer to read from.
    
    offset - Where to begin reading.
    
    Returns:
    
    The next boolean in the buffer.
  - readBoolean
```
public static boolean readBoolean(byte[] in)
```
    Read a boolean from a byte array. This is equivalent to calling readBoolean(in, 0).
    
    Parameters:
    
    in - The buffer to read from.
    
    Returns:
    
    The first boolean in the buffer.
  - reallySkip
```
public static void reallySkip(java.io.InputStream in,
                              long count)
                       throws java.io.IOException
```
    Call InputStream.skip until exactly count bytes have been skipped. If InputStream.skip ever returns a negative number then an EOFException is thrown.
    
    Parameters:
    
    in - The InputStream to skip.
    
    count - The number of bytes to skip.
    
    Throws:
    
    java.io.IOException - If the bytes cannot be skipped for some reason.
  - reallySkip
```
public static void reallySkip(java.io.DataInput in,
                              int count)
                       throws java.io.IOException
```
    Call DataInput.skip until exactly count bytes have been skipped. If DataInput.skip ever returns a negative number then an EOFException is thrown.
    
    Parameters:
    
    in - The DataInput to skip.
    
    count - The number of bytes to skip.
    
    Throws:
    
    java.io.IOException - If the bytes cannot be skipped for some reason.
  - writeEntity
```
public static void writeEntity(Entity e,
                               java.io.OutputStream out)
                        throws java.io.IOException
```
    Write an entity to a stream.
    
    Parameters:
    
    e - The entity to write.
    
    out - The OutputStream to write to.
    
    Throws:
    
    java.io.IOException - If there is a problem writing to the stream.
  - writeEntity
```
public static void writeEntity(Entity e,
                               java.io.DataOutput out)
                        throws java.io.IOException
```
    Write an entity to a DataOutput.
    
    Parameters:
    
    e - The entity to write.
    
    out - The DataOutput to write to.
    
    Throws:
    
    java.io.IOException - If there is a problem writing to the stream.
  - readEntity
```
public static Entity readEntity(java.io.InputStream in)
                         throws java.io.IOException
```
    Read an entity from a stream.
    
    Parameters:
    
    in - The InputStream to read from.
    
    Returns:
    
    A new Entity, or null if the entity URN is not recognised.
    
    Throws:
    
    java.io.IOException - If there is a problem reading from the stream.
  - readEntity
```
public static Entity readEntity(java.io.DataInput in)
                         throws java.io.IOException
```
    Read an entity from a DataInput.
    
    Parameters:
    
    in - The DataInput to read from.
    
    Returns:
    
    A new Entity, or null if the entity URN is not recognised.
    
    Throws:
    
    java.io.IOException - If there is a problem reading from the stream.
  - writeProperty
```
public static void writeProperty(Property p,
                                 java.io.OutputStream out)
                          throws java.io.IOException
```
    Write a property to a stream.
    
    Parameters:
    
    p - The property to write.
    
    out - The OutputStream to write to.
    
    Throws:
    
    java.io.IOException - If there is a problem writing to the stream.
  - writeProperty
```
public static void writeProperty(Property p,
                                 java.io.DataOutput out)
                          throws java.io.IOException
```
    Write a property to a DataOutput.
    
    Parameters:
    
    p - The property to write.
    
    out - The DataOutput to write to.
    
    Throws:
    
    java.io.IOException - If there is a problem writing to the stream.
  - readProperty
```
public static Property readProperty(java.io.InputStream in)
                             throws java.io.IOException
```
    Read a property from a stream.
    
    Parameters:
    
    in - The InputStream to read from.
    
    Returns:
    
    A new Property, or null if the property URN is not recognised.
    
    Throws:
    
    java.io.IOException - If there is a problem reading from the stream.
  - readProperty
```
public static Property readProperty(java.io.DataInput in)
                             throws java.io.IOException
```
    Read a property from a DataInput.
    
    Parameters:
    
    in - The DataInput to read from.
    
    Returns:
    
    A new Property, or null if the property URN is not recognised.
    
    Throws:
    
    java.io.IOException - If there is a problem reading from the stream.
  - writeMessage
```
public static void writeMessage(Message m,
                                java.io.OutputStream out)
                         throws java.io.IOException
```
    Write a message to a stream.
    
    Parameters:
    
    m - The message to write.
    
    out - The OutputStream to write to.
    
    Throws:
    
    java.io.IOException - If there is a problem writing to the stream.
  - writeMessage
```
public static void writeMessage(Message m,
                                java.io.DataOutput out)
                         throws java.io.IOException
```
    Write a message to a DataOutput.
    
    Parameters:
    
    m - The message to write.
    
    out - The DataOutput to write to.
    
    Throws:
    
    java.io.IOException - If there is a problem writing to the stream.
  - readMessage
```
public static Message readMessage(java.io.InputStream in)
                           throws java.io.IOException
```
    Read a message from a stream.
    
    Parameters:
    
    in - The InputStream to read from.
    
    Returns:
    
    A new Message, or null if the message URN is not recognised.
    
    Throws:
    
    java.io.IOException - If there is a problem reading from the stream.
  - readMessage
```
public static Message readMessage(java.io.DataInput in)
                           throws java.io.IOException
```
    Read a message from a DataInput.
    
    Parameters:
    
    in - The DataInput to read from.
    
    Returns:
    
    A new Message, or null if the message URN is not recognised.
    
    Throws:
    
    java.io.IOException - If there is a problem reading from the stream.
  - readFloat32
```
public static float readFloat32(java.io.InputStream in)
                         throws java.io.IOException
```
    Read a 32-bit float from an input stream, big-endian style.
    
    Parameters:
    
    in - The InputStream to read from.
    
    Returns:
    
    The next big-endian, 32-bit float in the stream.
    
    Throws:
    
    java.io.IOException - If the InputStream blows up.
    
    java.io.EOFException - If the end of the stream is reached.
  - writeFloat32
```
public static void writeFloat32(float f,
                                java.io.OutputStream out)
                         throws java.io.IOException
```
    Write a 32-bit float to an OutputStream, big-endian style.
    
    Parameters:
    
    f - The float to write.
    
    out - The OutputStream to write it to.
    
    Throws:
    
    java.io.IOException - If the OutputStream blows up.
  - writeFloat32
```
public static void writeFloat32(float f,
                                java.io.DataOutput out)
                         throws java.io.IOException
```
    Write a 32-bit float to a DataOutput, big-endian style.
    
    Parameters:
    
    f - The float to write.
    
    out - The DataOutput to write it to.
    
    Throws:
    
    java.io.IOException - If the DataOutput blows up.
  - writeFloat32
```
public static void writeFloat32(float f,
                                byte[] out,
                                int offset)
```
    Write a 32-bit float to a byte array, big-endian style.
    
    Parameters:
    
    f - The float to write.
    
    out - The buffer to write it to.
    
    offset - Where in the buffer to write it.
  - readFloat32
```
public static float readFloat32(java.io.DataInput in)
                         throws java.io.IOException
```
    Read a 32-bit float from a DataInput.
    
    Parameters:
    
    in - The DataInput to read from.
    
    Returns:
    
    The next big-endian, 32-bit float in the stream.
    
    Throws:
    
    java.io.IOException - If the DataInput blows up.
    
    java.io.EOFException - If the end of the stream is reached.

Class EncodingTools

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INT_32_SIZE

Method Detail

writeInt32

writeInt32

writeInt32

readInt32

readInt32

readInt32LE

readInt32

readInt32

writeString

writeString

writeString

readString

readString

readString

readString

readBytes

readBytes

writeDouble

writeDouble

writeDouble

readDouble

readDouble

readDouble

readDouble

writeBoolean

writeBoolean

writeBoolean

readBoolean

readBoolean

readBoolean

readBoolean

reallySkip

reallySkip

writeEntity

writeEntity

readEntity

readEntity

writeProperty

writeProperty

readProperty

readProperty

writeMessage

writeMessage

readMessage

readMessage

readFloat32

writeFloat32

writeFloat32

writeFloat32

readFloat32