Package io.riada.insight.model

Class ImmutableDocumentationSpace

java.lang.Object
io.riada.insight.model.DocumentationSpace
io.riada.insight.model.ImmutableDocumentationSpace
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class ImmutableDocumentationSpace extends DocumentationSpace
Immutable implementation of DocumentationSpace.

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

  • Method Details

    • key

      public String key()
      Specified by:
      key in class DocumentationSpace
      Returns:
      The value of the key attribute

    • name

      public String name()
      Specified by:
      name in class DocumentationSpace
      Returns:
      The value of the name attribute

    • withKey

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

    • withName

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

    • equals

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

    • toString

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

    • copyOf

      public static ImmutableDocumentationSpace copyOf(DocumentationSpace instance)
      Creates an immutable copy of a DocumentationSpace 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 DocumentationSpace instance

    • builder

      public static ImmutableDocumentationSpace.Builder builder()
      Creates a builder for ImmutableDocumentationSpace. 
       ImmutableDocumentationSpace.builder()
    .setKey(String) // required key
    .setName(String) // required name
    .build();
      Returns:
      A new ImmutableDocumentationSpace builder