Package com.pnfsoftware.jeb.util.io

Enum Class Endianness

java.lang.Object
java.lang.Enum<Endianness>
com.pnfsoftware.jeb.util.io.Endianness
All Implemented Interfaces:
Serializable, Comparable<Endianness>, Constable
@Ser public enum Endianness extends Enum<Endianness>
An enumeration version of ByteOrder.

Note: ByteOrder was introduced before Java 5, and true enums did not exist at the time.

  • Enum Constant Details

    • BIG_ENDIAN

      public static final Endianness BIG_ENDIAN
      Big-endian enumerated value.

    • LITTLE_ENDIAN

      public static final Endianness LITTLE_ENDIAN
      Little-endian enumerated value.

    • MIDDLE_ENDIAN

      public static final Endianness MIDDLE_ENDIAN
      Middle-endian (aka "PDP" endianness)

  • Method Details

    • values

      public static Endianness[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Endianness valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • toByteOrder

      public ByteOrder toByteOrder()
      Convert to Java's byte-order object.
      Returns:
      matching ByteOrder

    • isBig

      public boolean isBig()
      Determine whether this value is big-endian.
      Returns:
      true for BIG_ENDIAN

    • isLittle

      public boolean isLittle()
      Determine whether this value is little-endian.
      Returns:
      true for LITTLE_ENDIAN

    • isMiddle

      public boolean isMiddle()
      Determine whether this value is middle-endian.
      Returns:
      true for MIDDLE_ENDIAN

    • fromByteOrder

      public static Endianness fromByteOrder(ByteOrder order)
      Convert Java's byte-order object to an enum value.
      Parameters:
      order - byte order
      Returns:
      matching endianness, or null

    • nativeOrder

      public static Endianness nativeOrder()
      Get the native byte order as an enum value.
      Returns:
      native byte order

    • toString

      public String toString()
      Overrides:
      toString in class Enum<Endianness>