com.apple.foundationdb.record.metadata

Class FormerIndex

java.lang.Object

com.apple.foundationdb.record.metadata.FormerIndex

@API(value=MAINTAINED)
public class FormerIndex
extends Object

The location where a deleted index used to live. Nothing is remembered about the index other than this, so that the now-unused range can be deleted when an older record store is upgraded to newer meta-data.

Constructor Summary

Constructors

Constructor and Description
FormerIndex(Object subspaceKey, int addedVersion, int removedVersion, String formerName)
FormerIndex(RecordMetaDataProto.FormerIndex proto)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getAddedVersion() Get the version at which the index was first added.
String	getFormerName() Get the name under which the index existed, if known.
int	getRemovedVersion() Get the version at which the index was removed.
Object	getSubspaceKey() Get the subspace key formerly occupied by the index.
Object	getSubspaceTupleKey() Get a Tuple-encodable version of the subspace key formerly occupied by the index.
int	getVersion() Deprecated. use getRemovedVersion()
int	hashCode()
RecordMetaDataProto.FormerIndex	toProto()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FormerIndex

public FormerIndex(@Nonnull
                   Object subspaceKey,
                   int addedVersion,
                   int removedVersion,
                   @Nullable
                   String formerName)

FormerIndex

public FormerIndex(@Nonnull
                   RecordMetaDataProto.FormerIndex proto)

Method Detail

getSubspaceKey

@Nonnull
public Object getSubspaceKey()

Get the subspace key formerly occupied by the index. This subspace will be cleared for record stores old enough to have seen the index.

Returns:

the index subspace key

getSubspaceTupleKey

@Nonnull
public Object getSubspaceTupleKey()

Get a Tuple-encodable version of the subspace key formerly occupied by the index. As the subspace key is not guaranteed to be of a Tuple-encodable type on its own, this method is preferred over getSubspaceKey() if one is constructing a key to read or write data from the database.

Returns:

a Tuple-encodable version of index subspace key

getVersion

@Deprecated
public int getVersion()

Deprecated. use getRemovedVersion()

Synonym for getRemovedVersion().

Returns:

the removed version

getAddedVersion

public int getAddedVersion()

Get the version at which the index was first added.

Returns:

the added version

getRemovedVersion

public int getRemovedVersion()

Get the version at which the index was removed.

Returns:

the removed version

getFormerName

@Nullable
public String getFormerName()

Get the name under which the index existed, if known.

Returns:

the former name

toProto

@Nonnull
public RecordMetaDataProto.FormerIndex toProto()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object