Package org.xrpl.xrpl4j.codec.binary

Class ImmutableFieldHeader

java.lang.Object
org.xrpl.xrpl4j.codec.binary.ImmutableFieldHeader
All Implemented Interfaces:
FieldHeader
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class ImmutableFieldHeader extends Object implements FieldHeader
Immutable implementation of FieldHeader.

Use the builder to create immutable instances: ImmutableFieldHeader.builder().

  • Method Details

    • fieldCode

      public int fieldCode()
      Specified by:
      fieldCode in interface FieldHeader
      Returns:
      The value of the fieldCode attribute

    • typeCode

      public int typeCode()
      Specified by:
      typeCode in interface FieldHeader
      Returns:
      The value of the typeCode attribute

    • withFieldCode

      public final ImmutableFieldHeader withFieldCode(int value)
      Copy the current immutable object by setting a value for the fieldCode attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for fieldCode
      Returns:
      A modified copy of the this object

    • withTypeCode

      public final ImmutableFieldHeader withTypeCode(int value)
      Copy the current immutable object by setting a value for the typeCode attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for typeCode
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ImmutableFieldHeader that have equal attribute values.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: fieldCode, typeCode.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Prints the immutable value FieldHeader with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • copyOf

      public static ImmutableFieldHeader copyOf(FieldHeader instance)
      Creates an immutable copy of a FieldHeader value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable FieldHeader instance

    • builder

      public static ImmutableFieldHeader.Builder builder()
      Creates a builder for ImmutableFieldHeader. 
       ImmutableFieldHeader.builder()
    .fieldCode(int) // required fieldCode
    .typeCode(int) // required typeCode
    .build();
      Returns:
      A new ImmutableFieldHeader builder