Class ImmutableDocumentationPage

java.lang.Object
io.riada.insight.model.DocumentationPage
io.riada.insight.model.ImmutableDocumentationPage

@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class ImmutableDocumentationPage extends DocumentationPage
Immutable implementation of DocumentationPage.

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

  • Method Details

    • id

      public Long id()
      Specified by:
      id in class DocumentationPage
      Returns:
      The value of the id attribute
    • title

      public String title()
      Specified by:
      title in class DocumentationPage
      Returns:
      The value of the title attribute
    • url

      public String url()
      Specified by:
      url in class DocumentationPage
      Returns:
      The value of the url attribute
    • providerId

      public String providerId()
      Specified by:
      providerId in class DocumentationPage
      Returns:
      The value of the providerId attribute
    • withId

      public final ImmutableDocumentationPage withId(Long 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
    • withTitle

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

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

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

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ImmutableDocumentationPage 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, title, url, providerId.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value
    • toString

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

      public static ImmutableDocumentationPage copyOf(DocumentationPage instance)
      Creates an immutable copy of a DocumentationPage 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 DocumentationPage instance
    • builder

      public static ImmutableDocumentationPage.Builder builder()
      Creates a builder for ImmutableDocumentationPage.
       ImmutableDocumentationPage.builder()
          .setId(Long) // required id
          .setTitle(String) // required title
          .setUrl(String) // required url
          .setProviderId(String) // required providerId
          .build();
       
      Returns:
      A new ImmutableDocumentationPage builder