Class CorrelationIdentifier
- java.lang.Object
-
- com.apple.foundationdb.record.query.plan.temp.CorrelationIdentifier
-
@API(EXPERIMENTAL) public class CorrelationIdentifier extends Object
A correlation identifier is an immutable object that is created with a string uniquely identifying it.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object o)
int
hashCode()
static CorrelationIdentifier
of(String id)
Create a new correlation identifier using the given string.static CorrelationIdentifier
randomID()
Create a new correlation identifier using a random string.String
toString()
Returns the backing string id.
-
-
-
Method Detail
-
of
@Nonnull public static CorrelationIdentifier of(@Nonnull String id)
Create a new correlation identifier using the given string. It is the callers responsibility to only use unique string values in order to avoid clashes.- Parameters:
id
- the identifier string- Returns:
- a new
CorrelationIdentifier
-
randomID
@Nonnull public static CorrelationIdentifier randomID()
Create a new correlation identifier using a random string. The returned correlation identifier can be assumed to be unique.- Returns:
- a new
CorrelationIdentifier
-
toString
public String toString()
Returns the backing string id.- Overrides:
toString
in classObject
- Returns:
- the string backing this
CorrelationIdentifier
-
-