Package org.geneontology.obographs.core.model

Class Meta

  • @ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class Meta
extends AbstractMeta
    A holder for metadata The information in a Meta object consists sets of PropertyValue objects, which associate the Meta object holder with some value via some property. The set of PropertyValue objects can be partitioned into two subsets: 1. PropertyValues corresponding to a specific explicitly modeled property type (e.g synonym) 2. generic BasicPropertyValues - anything property not explicitly modeled
    Author:
    cjm

    • Method Detail

      • getComments

        public com.google.common.collect.ImmutableList<String> getComments()
        Specified by:
        getComments in class AbstractMeta
        Returns:
        The value of the comments attribute

      • getSubsets

        public com.google.common.collect.ImmutableList<String> getSubsets()
        Specified by:
        getSubsets in class AbstractMeta
        Returns:
        The value of the subsets attribute

      • getXrefsValues

        public com.google.common.collect.ImmutableList<String> getXrefsValues()
        Overrides:
        getXrefsValues in class AbstractMeta
        Returns:
        The value of the xrefsValues attribute

      • getDeprecated

        public boolean getDeprecated()
        Overrides:
        getDeprecated in class AbstractMeta
        Returns:
        The value of the deprecated attribute

      • withDefinition

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

      • withComments

        public final Meta withComments​(String... elements)
        Copy the current immutable object with elements that replace the content of comments.
        Parameters:
        elements - The elements to set
        Returns:
        A modified copy of this object

      • withComments

        public final Meta withComments​(Iterable<String> elements)
        Copy the current immutable object with elements that replace the content of comments. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        elements - An iterable of comments elements to set
        Returns:
        A modified copy of this object

      • withSubsets

        public final Meta withSubsets​(String... elements)
        Copy the current immutable object with elements that replace the content of subsets.
        Parameters:
        elements - The elements to set
        Returns:
        A modified copy of this object

      • withSubsets

        public final Meta withSubsets​(Iterable<String> elements)
        Copy the current immutable object with elements that replace the content of subsets. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        elements - An iterable of subsets elements to set
        Returns:
        A modified copy of this object

      • withSynonyms

        public final Meta withSynonyms​(SynonymPropertyValue... elements)
        Copy the current immutable object with elements that replace the content of synonyms.
        Parameters:
        elements - The elements to set
        Returns:
        A modified copy of this object

      • withSynonyms

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

      • withXrefs

        public final Meta withXrefs​(XrefPropertyValue... elements)
        Copy the current immutable object with elements that replace the content of xrefs.
        Parameters:
        elements - The elements to set
        Returns:
        A modified copy of this object

      • withXrefs

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

      • withXrefsValues

        public final Meta withXrefsValues​(String... elements)
        Copy the current immutable object with elements that replace the content of xrefsValues.
        Parameters:
        elements - The elements to set
        Returns:
        A modified copy of this object

      • withXrefsValues

        public final Meta withXrefsValues​(Iterable<String> elements)
        Copy the current immutable object with elements that replace the content of xrefsValues. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        elements - An iterable of xrefsValues elements to set
        Returns:
        A modified copy of this object

      • withBasicPropertyValues

        public final Meta withBasicPropertyValues​(BasicPropertyValue... elements)
        Copy the current immutable object with elements that replace the content of basicPropertyValues.
        Parameters:
        elements - The elements to set
        Returns:
        A modified copy of this object

      • withBasicPropertyValues

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

      • withVersion

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

      • withDeprecated

        public final Meta withDeprecated​(boolean value)
        Copy the current immutable object by setting a value for the deprecated attribute. A value equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for deprecated
        Returns:
        A modified copy of the this object

      • equals

        public boolean equals​(@Nullable
                      Object another)
        This instance is equal to all instances of Meta 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: definition, comments, subsets, synonyms, xrefs, xrefsValues, basicPropertyValues, version, deprecated.
        Overrides:
        hashCode in class Object
        Returns:
        hashCode value

      • toString

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

      • copyOf

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