Package com.apple.foundationdb.record.query.plan.temp

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

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getId()
int	hashCode()
static Map<CorrelationIdentifier,CorrelationIdentifier>	identityMappingMap(Set<CorrelationIdentifier> aliases)	Return a mapping between a -> a for all a in the given set as a view on the original set.
static CorrelationIdentifier	of(String id)	Create a new correlation identifier using the given string.
String	toString()	Returns the backing string id.
static CorrelationIdentifier	uniqueID()	Create a new correlation identifier.
static CorrelationIdentifier	uniqueID(Class<?> clazz)	Create a new correlation identifier.
static CorrelationIdentifier	uniqueID(Class<?> clazz, String prefix)	Create a new correlation identifier.

Methods inherited from class java.lang.Object

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

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

uniqueID

@Nonnull
public static CorrelationIdentifier uniqueID()

Create a new correlation identifier. The returned correlation identifier can be assumed to be unique.

Returns:

a new unique CorrelationIdentifier

uniqueID

@Nonnull
public static CorrelationIdentifier uniqueID(@Nonnull
                                             Class<?> clazz)

Create a new correlation identifier. The returned correlation identifier can be assumed to be unique.

Parameters:

clazz - to specify the kind of ewntity this identifier is going to be used for. This is really only useful if a Debugger is set.

Returns:

a new unique CorrelationIdentifier

uniqueID

@Nonnull
public static CorrelationIdentifier uniqueID(@Nonnull
                                             Class<?> clazz,
                                             @Nonnull
                                             String prefix)

Create a new correlation identifier. The returned correlation identifier can be assumed to be unique.

Parameters:

clazz - to specify the kind of ewntity this identifier is going to be used for. This is really only useful if a Debugger is set.

prefix - a prefix for the returned identifier

Returns:

a new unique CorrelationIdentifier

getId

@Nonnull
public String getId()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns the backing string id.

Overrides:

toString in class Object

Returns:

the string backing this CorrelationIdentifier

identityMappingMap

public static Map<CorrelationIdentifier,CorrelationIdentifier> identityMappingMap(@Nonnull
                                                                                        Set<CorrelationIdentifier> aliases)

Return a mapping between a -> a for all a in the given set as a view on the original set.

Parameters:

aliases - set to compute the identity mappings for

Returns:

a view on the set that maps each element in aliases to itself.