org.opends.server.backends.pluggable.spi

Class TreeName

java.lang.Object

org.opends.server.backends.pluggable.spi.TreeName

All Implemented Interfaces:

Comparable<TreeName>

public final class TreeName
extends Object
implements Comparable<TreeName>

Represents the name of a tree (key-value store) in a database. A tree name is made of the baseDN it is part of, and the identifier of the index it represents.

Note: This class assumes name components don't contain a '/'.

Constructor Summary

Constructors

Constructor and Description
TreeName(String baseDN, String indexId) Builds a tree name.

Method Summary

Modifier and Type	Method and Description
int	compareTo(TreeName o)
boolean	equals(Object obj)
String	getBaseDN() Returns the base DN.
String	getIndexId() Returns the index identifier.
int	hashCode()
String	toString()
static TreeName	valueOf(String treeName) Builds a new TreeName object based on the provided string representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeName

public TreeName(String baseDN,
                String indexId)

Builds a tree name.

Parameters:

baseDN - the base DN

indexId - the index identifier

Method Detail

valueOf

public static TreeName valueOf(String treeName)

Builds a new TreeName object based on the provided string representation.

Parameters:

treeName - the string representation of the tree name

Returns:

a new TreeName object constructed from the provided string

getBaseDN

public String getBaseDN()

Returns the base DN.

Returns:

a String representing the base DN

getIndexId

public String getIndexId()

Returns the index identifier.

Returns:

a String representing the base DN

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(TreeName o)

Specified by:

compareTo in interface Comparable<TreeName>