Module com.zeroc.ice
Package com.zeroc.Ice

Enum Class OptionalFormat

java.lang.Object
java.lang.Enum<OptionalFormat>
com.zeroc.Ice.OptionalFormat
All Implemented Interfaces:
Serializable, Comparable<OptionalFormat>, Constable
public enum OptionalFormat extends Enum<OptionalFormat>
The optional format, used for marshaling optional fields and arguments. It describes how the data is marshaled and how it can be skipped by the unmarshaling code if the optional isn't known to the receiver.

  • Enum Constant Details

    • F1

      public static final OptionalFormat F1
      Fixed 1-byte encoding.

    • F2

      public static final OptionalFormat F2
      Fixed 2-byte encoding.

    • F4

      public static final OptionalFormat F4
      Fixed 4-byte encoding.

    • F8

      public static final OptionalFormat F8
      Fixed 8-byte encoding.

    • Size

      public static final OptionalFormat Size
      "Size encoding" using either 1 or 5 bytes. Used by enums, class identifiers, etc.

    • VSize

      public static final OptionalFormat VSize
      Variable "size encoding" using either 1 or 5 bytes followed by data. Used by strings, fixed size structs, and containers whose size can be computed prior to marshaling.

    • FSize

      public static final OptionalFormat FSize
      Fixed "size encoding" using 4 bytes followed by data. Used by variable-size structs, and containers whose sizes can't be computed prior to unmarshaling.

    • Class

      public static final OptionalFormat Class
      Class instance. No longer supported.

  • Method Details

    • values

      public static OptionalFormat[] 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 OptionalFormat 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

    • value

      public int value()
      Returns the integer value of this enumerator.
      Returns:
      the integer value of this enumerator

    • valueOf

      public static OptionalFormat valueOf(int v)
      Returns the enumerator corresponding to the given integer value.
      Parameters:
      v - the integer value of the enumerator
      Returns:
      the enumerator corresponding to the given integer value, or null if no such enumerator exists