org.dizitart.no2

Class Index

java.lang.Object

org.dizitart.no2.Index

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Index>

public class Index
extends java.lang.Object
implements java.lang.Comparable<Index>, java.io.Serializable

Represents a nitrite database index.

Since:

1.0

See Also:

PersistentCollection.createIndex(String, IndexOptions), Serialized Form

Constructor Summary

Constructors

Constructor and Description
Index(IndexType indexType, java.lang.String field, java.lang.String collectionName) Instantiates a new Index.

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
int	compareTo(Index other)
boolean	equals(java.lang.Object o)
java.lang.String	getCollectionName() Gets the collection name.
java.lang.String	getField() Gets the target value for the index.
IndexType	getIndexType() Specifies the type of the index.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Index

public Index(IndexType indexType,
             java.lang.String field,
             java.lang.String collectionName)

Instantiates a new Index.

Parameters:

indexType - the index type

field - the value

collectionName - the collection name

Method Detail

compareTo

public int compareTo(Index other)

Specified by:

compareTo in interface java.lang.Comparable<Index>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getIndexType

public IndexType getIndexType()

Specifies the type of the index.

Returns:

the type of the index.

See Also:

IndexType

getField

public java.lang.String getField()

Gets the target value for the index.

Returns:

the target value.

getCollectionName

public java.lang.String getCollectionName()

Gets the collection name.

Returns:

the collection name.