WritableUtils (Apache Hadoop Common 3.4.1.200-dep-1000 API)

java.lang.Object
- org.apache.hadoop.io.WritableUtils

@Public
@Stable
public final class WritableUtils
extends java.lang.Object

Constructor Summary

Constructors
Constructor Description

WritableUtils()

Constructors
Constructor	Description
`WritableUtils()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static <T extends Writable> T`	`clone(T orig, Configuration conf)`	Make a copy of a writable object using serialization to a buffer.
`static void`	`cloneInto(Writable dst, Writable src)`	Deprecated. use ReflectionUtils.cloneInto instead.
`static int`	`decodeVIntSize(byte value)`	Parse the first byte of a vint/vlong to determine the number of bytes
`static void`	`displayByteArray(byte[] record)`
`static int`	`getVIntSize(long i)`	Get the encoded length if an integer is stored in a variable-length format.
`static boolean`	`isNegativeVInt(byte value)`	Given the first byte of a vint/vlong, determine the sign
`static byte[]`	`readCompressedByteArray(java.io.DataInput in)`
`static java.lang.String`	`readCompressedString(java.io.DataInput in)`
`static java.lang.String[]`	`readCompressedStringArray(java.io.DataInput in)`
`static <T extends java.lang.Enum<T>> T`	`readEnum(java.io.DataInput in, java.lang.Class<T> enumType)`	Read an Enum value from DataInput, Enums are read and written using String values.
`static java.lang.String`	`readString(java.io.DataInput in)`
`static java.lang.String[]`	`readStringArray(java.io.DataInput in)`
`static java.lang.String`	`readStringSafely(java.io.DataInput in, int maxLength)`	Read a string, but check it for sanity.
`static int`	`readVInt(java.io.DataInput stream)`	Reads a zero-compressed encoded integer from input stream and returns it.
`static int`	`readVIntInRange(java.io.DataInput stream, int lower, int upper)`	Reads an integer from the input stream and returns it.
`static long`	`readVLong(java.io.DataInput stream)`	Reads a zero-compressed encoded long from input stream and returns it.
`static void`	`skipCompressedByteArray(java.io.DataInput in)`
`static void`	`skipFully(java.io.DataInput in, int len)`	Skip len number of bytes in input streamin
`static byte[]`	`toByteArray(Writable... writables)`	Convert writables to a byte array.
`static int`	`writeCompressedByteArray(java.io.DataOutput out, byte[] bytes)`
`static int`	`writeCompressedString(java.io.DataOutput out, java.lang.String s)`
`static void`	`writeCompressedStringArray(java.io.DataOutput out, java.lang.String[] s)`
`static void`	`writeEnum(java.io.DataOutput out, java.lang.Enum<?> enumVal)`	writes String value of enum to DataOutput.
`static void`	`writeString(java.io.DataOutput out, java.lang.String s)`
`static void`	`writeStringArray(java.io.DataOutput out, java.lang.String[] s)`
`static void`	`writeVInt(java.io.DataOutput stream, int i)`	Serializes an integer to a binary stream with zero-compressed encoding.
`static void`	`writeVLong(java.io.DataOutput stream, long i)`	Serializes a long to a binary stream with zero-compressed encoding.

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

- Constructor Detail
  - WritableUtils
```
public WritableUtils()
```
- Method Detail
  - readCompressedByteArray
```
public static byte[] readCompressedByteArray(java.io.DataInput in)
                                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - skipCompressedByteArray
```
public static void skipCompressedByteArray(java.io.DataInput in)
                                    throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeCompressedByteArray
```
public static int writeCompressedByteArray(java.io.DataOutput out,
                                           byte[] bytes)
                                    throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - readCompressedString
```
public static java.lang.String readCompressedString(java.io.DataInput in)
                                             throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeCompressedString
```
public static int writeCompressedString(java.io.DataOutput out,
                                        java.lang.String s)
                                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeString
```
public static void writeString(java.io.DataOutput out,
                               java.lang.String s)
                        throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - readString
```
public static java.lang.String readString(java.io.DataInput in)
                                   throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeStringArray
```
public static void writeStringArray(java.io.DataOutput out,
                                    java.lang.String[] s)
                             throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeCompressedStringArray
```
public static void writeCompressedStringArray(java.io.DataOutput out,
                                              java.lang.String[] s)
                                       throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - readStringArray
```
public static java.lang.String[] readStringArray(java.io.DataInput in)
                                          throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - readCompressedStringArray
```
public static java.lang.String[] readCompressedStringArray(java.io.DataInput in)
                                                    throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - displayByteArray
```
public static void displayByteArray(byte[] record)
```
  - clone
```
public static <T extends Writable> T clone(T orig,
                                           Configuration conf)
```
    Make a copy of a writable object using serialization to a buffer.
    
    Type Parameters:
    
    T - Generics Type T.
    
    Parameters:
    
    orig - The object to copy
    
    conf - input Configuration.
    
    Returns:
    
    The copied object
  - cloneInto
```
@Deprecated
public static void cloneInto(Writable dst,
                             Writable src)
                      throws java.io.IOException
```
    Deprecated.
    use ReflectionUtils.cloneInto instead.
    
    Make a copy of the writable object using serialization to a buffer.
    
    Parameters:
    
    dst - the object to copy from
    
    src - the object to copy into, which is destroyed
    
    Throws:
    
    java.io.IOException - raised on errors performing I/O.
  - writeVInt
```
public static void writeVInt(java.io.DataOutput stream,
                             int i)
                      throws java.io.IOException
```
    Serializes an integer to a binary stream with zero-compressed encoding. For -112 <= i <= 127, only one byte is used with the actual value. For other values of i, the first byte value indicates whether the integer is positive or negative, and the number of bytes that follow. If the first byte value v is between -113 and -116, the following integer is positive, with number of bytes that follow are -(v+112). If the first byte value v is between -121 and -124, the following integer is negative, with number of bytes that follow are -(v+120). Bytes are stored in the high-non-zero-byte-first order.
    
    Parameters:
    
    stream - Binary output stream
    
    i - Integer to be serialized
    
    Throws:
    
    java.io.IOException - raised on errors performing I/O.
  - writeVLong
```
public static void writeVLong(java.io.DataOutput stream,
                              long i)
                       throws java.io.IOException
```
    Serializes a long to a binary stream with zero-compressed encoding. For -112 <= i <= 127, only one byte is used with the actual value. For other values of i, the first byte value indicates whether the long is positive or negative, and the number of bytes that follow. If the first byte value v is between -113 and -120, the following long is positive, with number of bytes that follow are -(v+112). If the first byte value v is between -121 and -128, the following long is negative, with number of bytes that follow are -(v+120). Bytes are stored in the high-non-zero-byte-first order.
    
    Parameters:
    
    stream - Binary output stream
    
    i - Long to be serialized
    
    Throws:
    
    java.io.IOException - raised on errors performing I/O.
  - readVLong
```
public static long readVLong(java.io.DataInput stream)
                      throws java.io.IOException
```
    Reads a zero-compressed encoded long from input stream and returns it.
    
    Parameters:
    
    stream - Binary input stream
    
    Returns:
    
    deserialized long from stream.
    
    Throws:
    
    java.io.IOException - raised on errors performing I/O.
  - readVInt
```
public static int readVInt(java.io.DataInput stream)
                    throws java.io.IOException
```
    Reads a zero-compressed encoded integer from input stream and returns it.
    
    Parameters:
    
    stream - Binary input stream
    
    Returns:
    
    deserialized integer from stream.
    
    Throws:
    
    java.io.IOException - raised on errors performing I/O.
  - readVIntInRange
```
public static int readVIntInRange(java.io.DataInput stream,
                                  int lower,
                                  int upper)
                           throws java.io.IOException
```
    Reads an integer from the input stream and returns it. This function validates that the integer is between [lower, upper], inclusive.
    
    Parameters:
    
    stream - Binary input stream
    
    lower - input lower.
    
    upper - input upper.
    
    Returns:
    
    deserialized integer from stream.
    
    Throws:
    
    java.io.IOException - raised on errors performing I/O.
  - isNegativeVInt
```
public static boolean isNegativeVInt(byte value)
```
    Given the first byte of a vint/vlong, determine the sign
    
    Parameters:
    
    value - the first byte
    
    Returns:
    
    is the value negative
  - decodeVIntSize
```
public static int decodeVIntSize(byte value)
```
    Parse the first byte of a vint/vlong to determine the number of bytes
    
    Parameters:
    
    value - the first byte of the vint/vlong
    
    Returns:
    
    the total number of bytes (1 to 9)
  - getVIntSize
```
public static int getVIntSize(long i)
```
    Get the encoded length if an integer is stored in a variable-length format.
    
    Parameters:
    
    i - input i.
    
    Returns:
    
    the encoded length
  - readEnum
```
public static <T extends java.lang.Enum<T>> T readEnum(java.io.DataInput in,
                                                       java.lang.Class<T> enumType)
                                                throws java.io.IOException
```
    Read an Enum value from DataInput, Enums are read and written using String values.
    
    Type Parameters:
    
    T - Enum type
    
    Parameters:
    
    in - DataInput to read from
    
    enumType - Class type of Enum
    
    Returns:
    
    Enum represented by String read from DataInput
    
    Throws:
    
    java.io.IOException - raised on errors performing I/O.
  - writeEnum
```
public static void writeEnum(java.io.DataOutput out,
                             java.lang.Enum<?> enumVal)
                      throws java.io.IOException
```
    writes String value of enum to DataOutput.
    
    Parameters:
    
    out - Dataoutput stream
    
    enumVal - enum value
    
    Throws:
    
    java.io.IOException - raised on errors performing I/O.
  - skipFully
```
public static void skipFully(java.io.DataInput in,
                             int len)
                      throws java.io.IOException
```
    Skip len number of bytes in input streamin
    
    Parameters:
    
    in - input stream
    
    len - number of bytes to skip
    
    Throws:
    
    java.io.IOException - when skipped less number of bytes
  - toByteArray
```
public static byte[] toByteArray(Writable... writables)
```
    Convert writables to a byte array.
    
    Parameters:
    
    writables - input writables.
    
    Returns:
    
    ByteArray.
  - readStringSafely
```
public static java.lang.String readStringSafely(java.io.DataInput in,
                                                int maxLength)
                                         throws java.io.IOException,
                                                java.lang.IllegalArgumentException
```
    Read a string, but check it for sanity. The format consists of a vint followed by the given number of bytes.
    
    Parameters:
    
    in - the stream to read from
    
    maxLength - the largest acceptable length of the encoded string
    
    Returns:
    
    the bytes as a string
    
    Throws:
    
    java.io.IOException - if reading from the DataInput fails
    
    java.lang.IllegalArgumentException - if the encoded byte size for string is negative or larger than maxSize. Only the vint is read.

Class WritableUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WritableUtils

Method Detail

readCompressedByteArray

skipCompressedByteArray

writeCompressedByteArray

readCompressedString

writeCompressedString

writeString

readString

writeStringArray

writeCompressedStringArray

readStringArray

readCompressedStringArray

displayByteArray

clone

cloneInto

writeVInt

writeVLong

readVLong

readVInt

readVIntInRange

isNegativeVInt

decodeVIntSize

getVIntSize

readEnum

writeEnum

skipFully

toByteArray

readStringSafely