Class ImmutableLabel

  • All Implemented Interfaces:
    Label

    @ParametersAreNonnullByDefault
    @Generated("org.immutables.processor.ProxyProcessor")
    @Immutable
    @CheckReturnValue
    public final class ImmutableLabel
    extends Object
    implements Label
    Immutable implementation of Label.

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

    • Method Detail

      • url

        @Nullable
        public URI url()
        URL
        Specified by:
        url in interface Label
      • name

        @Nullable
        public String name()
        Name
        Specified by:
        name in interface Label
      • color

        @Nullable
        public String color()
        Color
        Specified by:
        color in interface Label
      • withUrl

        public final ImmutableLabel withUrl​(@Nullable
                                            URI value)
        Copy the current immutable object by setting a value for the url attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for url (can be null)
        Returns:
        A modified copy of the this object
      • withName

        public final ImmutableLabel withName​(@Nullable
                                             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 (can be null)
        Returns:
        A modified copy of the this object
      • withColor

        public final ImmutableLabel withColor​(@Nullable
                                              String value)
        Copy the current immutable object by setting a value for the color attribute. An equals check used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for color (can be null)
        Returns:
        A modified copy of the this object
      • equals

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

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

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

        public static ImmutableLabel.Builder builder()
        Creates a builder for ImmutableLabel.
         ImmutableLabel.builder()
            .url(java.net.URI | null) // nullable url
            .name(String | null) // nullable name
            .color(String | null) // nullable color
            .build();
         
        Returns:
        A new ImmutableLabel builder