Package io.riada.insight.model

Class ImmutableDocumentationProvider

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

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

  • Method Details

    • id

      public String id()
      Specified by:
      id in class DocumentationProvider
      Returns:
      The value of the id attribute

    • name

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

    • uri

      public String uri()
      Specified by:
      uri in class DocumentationProvider
      Returns:
      The value of the uri attribute

    • withId

      public final ImmutableDocumentationProvider 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

    • withName

      public final ImmutableDocumentationProvider 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

    • withUri

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

    • equals

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

    • toString

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

    • copyOf

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

    • builder

      public static ImmutableDocumentationProvider.Builder builder()
      Creates a builder for ImmutableDocumentationProvider. 
       ImmutableDocumentationProvider.builder()
    .setId(String) // required id
    .setName(String) // required name
    .setUri(String) // required uri
    .build();
      Returns:
      A new ImmutableDocumentationProvider builder