Package io.resys.hdes.client.api

Class ImmutableHistoryEntity

java.lang.Object
io.resys.hdes.client.api.ImmutableHistoryEntity
All Implemented Interfaces:
HdesStore.HistoryEntity
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class ImmutableHistoryEntity extends Object implements HdesStore.HistoryEntity
Immutable implementation of HdesStore.HistoryEntity.

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

  • Method Details

    • getId

      public String getId()
      Specified by:
      getId in interface HdesStore.HistoryEntity
      Returns:
      The value of the id attribute

    • getBodyType

      public AstBody.AstBodyType getBodyType()
      Specified by:
      getBodyType in interface HdesStore.HistoryEntity
      Returns:
      The value of the bodyType attribute

    • getBody

      public com.google.common.collect.ImmutableList<HdesStore.DetachedEntity> getBody()
      Specified by:
      getBody in interface HdesStore.HistoryEntity
      Returns:
      The value of the body attribute

    • withId

      public final ImmutableHistoryEntity withId(String value)
      Copy the current immutable object by setting a value for the id attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for id
      Returns:
      A modified copy of the this object

    • withBodyType

      public final ImmutableHistoryEntity withBodyType(AstBody.AstBodyType value)
      Copy the current immutable object by setting a value for the bodyType attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for bodyType
      Returns:
      A modified copy of the this object

    • withBody

      public final ImmutableHistoryEntity withBody(HdesStore.DetachedEntity... elements)
      Copy the current immutable object with elements that replace the content of body.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withBody

      public final ImmutableHistoryEntity withBody(Iterable<? extends HdesStore.DetachedEntity> elements)
      Copy the current immutable object with elements that replace the content of body. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of body elements to set
      Returns:
      A modified copy of this object

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ImmutableHistoryEntity 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: id, bodyType, body.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

      public static ImmutableHistoryEntity copyOf(HdesStore.HistoryEntity instance)
      Creates an immutable copy of a HdesStore.HistoryEntity 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 HistoryEntity instance

    • builder

      public static ImmutableHistoryEntity.Builder builder()
      Creates a builder for ImmutableHistoryEntity. 
       ImmutableHistoryEntity.builder()
    .id(String) // required id
    .bodyType(io.resys.hdes.client.api.ast.AstBody.AstBodyType) // required bodyType
    .addBody|addAllBody(io.resys.hdes.client.api.HdesStore.DetachedEntity) // body elements
    .build();
      Returns:
      A new ImmutableHistoryEntity builder