Directive

java.lang.Object
- java.lang.Enum<Directive>
- - net.sf.rubycollect4j.packer.Directive

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Directive>
```
public enum Directive
extends java.lang.Enum<Directive>
```
Directive defines available directives for RubyArray.pack(String).

Enum Constant Summary

Enum Constants
Enum Constant and Description
`a` String, null padded with a count.
`A` String, space padded with a count.
`b` String, bit string (LSB first)
`B` String, bit string (MSB first)
`c` 8-bit char.
`d` 64-bit double, native endian.
`D` 64-bit double, native endian.
`e` 32-bit float, little-endian.
`E` 64-bit double, little-endian.
`f` 32-bit float, native endian.
`F` 32-bit float, native endian.
`g` 32-bit float, big-endian.
`G` 64-bit double, big-endian.
`h` String, hex string (low nibble first)
`H` String, hex string (high nibble first)
`l` 32-bit int, native endian.
`lb` 32-bit int, big-endian.
`ll` 32-bit int, little-endian.
`q` 64-bit long, native endian.
`qb` 64-bit long, big-endian.
`ql` 64-bit long, little-endian.
`s` 16-bit short, native endian.
`sb` 16-bit short, big-endian.
`sl` 16-bit short, little-endian.
`U` UTF-16 character.
`Z` String, null padded with a count and null is added with *.

Field Summary

Fields
Modifier and Type Field and Description

static java.util.Map<java.lang.String,Directive> lookup

Fields
Modifier and Type	Field and Description
`static java.util.Map<java.lang.String,Directive>`	`lookup`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Object`	`cast(java.lang.Object o)` Casts an Object to corresponding Byte, Short, Integer or Long if the Object is a Number, Boolean or Character.
`boolean`	`isWidthAdjustable()` Returns true if the length of packed String is adjustable, false otherwise.
`java.lang.String`	`pack(byte[] bytes)` Packs an array of byte into a binary String.
`java.lang.String`	`pack(java.util.List<java.lang.Byte> bytes)` Packs a List of Byte into a binary String.
`java.lang.String`	`toString()`
`java.lang.Object`	`unpack(byte[] bytes)` Unpacks an array of byte into an Object.
`java.lang.Object`	`unpack(java.util.List<java.lang.Byte> bytes)` Unpacks a List of Byte into an Object.
`static Directive`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static Directive[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.
`static boolean`	`verify(java.lang.String template)` Verifies a template string.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - c
```
public static final Directive c
```
    8-bit char.
  - s
```
public static final Directive s
```
    16-bit short, native endian.
  - sb
```
public static final Directive sb
```
    16-bit short, big-endian. It should be used as s> in a template string.
  - sl
```
public static final Directive sl
```
    16-bit short, little-endian. It should be used as s< in a template string.
  - l
```
public static final Directive l
```
    32-bit int, native endian.
  - lb
```
public static final Directive lb
```
    32-bit int, big-endian. It should be used as l> in a template string.
  - ll
```
public static final Directive ll
```
    32-bit int, little-endian. It should be used as l< in a template string.
  - q
```
public static final Directive q
```
    64-bit long, native endian.
  - qb
```
public static final Directive qb
```
    64-bit long, big-endian. It should be used as q> in a template string.
  - ql
```
public static final Directive ql
```
    64-bit long, little-endian. It should be used as q< in a template string.
  - D
```
public static final Directive D
```
    64-bit double, native endian.
  - d
```
public static final Directive d
```
    64-bit double, native endian.
  - E
```
public static final Directive E
```
    64-bit double, little-endian.
  - G
```
public static final Directive G
```
    64-bit double, big-endian.
  - F
```
public static final Directive F
```
    32-bit float, native endian.
  - f
```
public static final Directive f
```
    32-bit float, native endian.
  - e
```
public static final Directive e
```
    32-bit float, little-endian.
  - g
```
public static final Directive g
```
    32-bit float, big-endian.
  - U
```
public static final Directive U
```
    UTF-16 character.
  - A
```
public static final Directive A
```
    String, space padded with a count.
  - a
```
public static final Directive a
```
    String, null padded with a count.
  - Z
```
public static final Directive Z
```
    String, null padded with a count and null is added with *.
  - B
```
public static final Directive B
```
    String, bit string (MSB first)
  - b
```
public static final Directive b
```
    String, bit string (LSB first)
  - H
```
public static final Directive H
```
    String, hex string (high nibble first)
  - h
```
public static final Directive h
```
    String, hex string (low nibble first)
- Field Detail
  - lookup
```
public static final java.util.Map<java.lang.String,Directive> lookup
```
- Method Detail
  - values
```
public static Directive[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Directive c : Directive.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Directive valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - isWidthAdjustable
```
public boolean isWidthAdjustable()
```
    Returns true if the length of packed String is adjustable, false otherwise.
    
    Returns:
    true if the length of packed String is adjustable, false otherwise
  - pack
```
public java.lang.String pack(java.util.List<java.lang.Byte> bytes)
```
    Packs a List of Byte into a binary String.
    
    Parameters:
    bytes - a List of Byte
    
    Returns:
    binary String represented in hex or ASCII format
  - pack
```
public java.lang.String pack(byte[] bytes)
```
    Packs an array of byte into a binary String.
    
    Parameters:
    bytes - an array of byte
    
    Returns:
    binary String represented in hex or ASCII format
  - unpack
```
public java.lang.Object unpack(java.util.List<java.lang.Byte> bytes)
```
    Unpacks a List of Byte into an Object.
    
    Parameters:
    bytes - a List of Byte
    
    Returns:
    Object
  - unpack
```
public java.lang.Object unpack(byte[] bytes)
```
    Unpacks an array of byte into an Object.
    
    Parameters:
    bytes - an array of byte
    
    Returns:
    Object
  - cast
```
public java.lang.Object cast(java.lang.Object o)
```
    Casts an Object to corresponding Byte, Short, Integer or Long if the Object is a Number, Boolean or Character.
    
    Parameters:
    o - any Object
    
    Returns:
    cast Object
  - verify
```
public static boolean verify(java.lang.String template)
```
    Verifies a template string.
    
    Parameters:
    template - a template string
    
    Returns:
    true if template is valid, otherwise false
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<Directive>

Enum Directive

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

c

s

sb

sl

l

lb

ll

q

qb

ql

D

d

E

G

F

f

e

g

U

A

a

Z

B

b

H

h

Field Detail

lookup

Method Detail

values

valueOf

isWidthAdjustable

pack

pack

unpack

unpack

cast

verify

toString