Package org.geneontology.obographs.core.model.meta

Class SynonymPropertyValue

java.lang.Object

org.geneontology.obographs.core.model.meta.AbstractSynonymPropertyValue

org.geneontology.obographs.core.model.meta.SynonymPropertyValue

All Implemented Interfaces:

Comparable<PropertyValue>, PropertyValue

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class SynonymPropertyValue
extends AbstractSynonymPropertyValue

A PropertyValue that represents a an alternative term for a node

Author:

cjm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SynonymPropertyValue.Builder	Builds instances of type SynonymPropertyValue.

Nested classes/interfaces inherited from class org.geneontology.obographs.core.model.meta.AbstractSynonymPropertyValue

AbstractSynonymPropertyValue.SCOPES

Method Summary

Modifier and Type	Method	Description
static SynonymPropertyValue	copyOf(AbstractSynonymPropertyValue instance)	Creates an immutable copy of a AbstractSynonymPropertyValue value.
boolean	equals(Object another)	This instance is equal to all instances of SynonymPropertyValue that have equal attribute values.
Meta	getMeta()
String	getPred()	Predicates correspond to OWL properties.
String	getSynonymType()
String	getVal()	The value of the property-value
com.google.common.collect.ImmutableList<String>	getXrefs()	An array denoting objects that support the property value assertion
int	hashCode()	Computes a hash code from attributes: pred, val, xrefs, meta, synonymType.
String	toString()	Prints the immutable value SynonymPropertyValue with attribute values.
SynonymPropertyValue	withMeta(Meta value)	Copy the current immutable object by setting a value for the meta attribute.
SynonymPropertyValue	withPred(String value)	Copy the current immutable object by setting a value for the pred attribute.
SynonymPropertyValue	withSynonymType(String value)	Copy the current immutable object by setting a value for the synonymType attribute.
SynonymPropertyValue	withVal(String value)	Copy the current immutable object by setting a value for the val attribute.
SynonymPropertyValue	withXrefs(Iterable<String> elements)	Copy the current immutable object with elements that replace the content of xrefs.
SynonymPropertyValue	withXrefs(String... elements)	Copy the current immutable object with elements that replace the content of xrefs.

Methods inherited from class org.geneontology.obographs.core.model.meta.AbstractSynonymPropertyValue

getTypes, isBroad, isExact, isNarrow, isRelated

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.geneontology.obographs.core.model.meta.PropertyValue

compareTo

Method Detail

getPred

public String getPred()

Predicates correspond to OWL properties. Like all preds in this datamodel, a pred is represented as a String which denotes a CURIE

Returns:

the pred

getVal

public String getVal()

The value of the property-value

Returns:

the val

getXrefs

public com.google.common.collect.ImmutableList<String> getXrefs()

An array denoting objects that support the property value assertion

Returns:

the xrefs

getMeta

@Nullable
public Meta getMeta()

Returns:

The value of the meta attribute

getSynonymType

public String getSynonymType()

Overrides:

getSynonymType in class AbstractSynonymPropertyValue

Returns:

The value of the synonymType attribute

withPred

public final SynonymPropertyValue withPred(String value)

Copy the current immutable object by setting a value for the pred attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for pred

Returns:

A modified copy of the this object

withVal

public final SynonymPropertyValue withVal(String value)

Copy the current immutable object by setting a value for the val attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for val

Returns:

A modified copy of the this object

withXrefs

public final SynonymPropertyValue withXrefs(String... 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 SynonymPropertyValue withXrefs(Iterable<String> 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

withMeta

public final SynonymPropertyValue withMeta(@Nullable
                                           Meta value)

Copy the current immutable object by setting a value for the meta attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for meta (can be null)

Returns:

A modified copy of the this object

withSynonymType

public final SynonymPropertyValue withSynonymType(String value)

Copy the current immutable object by setting a value for the synonymType attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for synonymType

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of SynonymPropertyValue 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: pred, val, xrefs, meta, synonymType.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value SynonymPropertyValue with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static SynonymPropertyValue copyOf(AbstractSynonymPropertyValue instance)

Creates an immutable copy of a AbstractSynonymPropertyValue 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 SynonymPropertyValue instance