com.cloudant.client.api.views

Class Key.ComplexKey

java.lang.Object

com.cloudant.client.api.views.Key.ComplexKey

Enclosing class:

Key

public static final class Key.ComplexKey
extends java.lang.Object

Provides methods for adding values to build a complex key array.

Since:

2.0.0

Method Summary

Modifier and Type	Method and Description
Key.ComplexKey	add(java.lang.Boolean... booleanKeys) Add one or more booleans to the complex key.
Key.ComplexKey	add(java.lang.Number... numberKeys) Add one or more numbers to the complex key.
Key.ComplexKey	add(java.lang.String... stringKeys) Add one or more strings to the complex key.
Key.ComplexKey	addHighSentinel() Add the high key sentinel value, which is guaranteed to sort last, to the complex key.
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	toJson()

Methods inherited from class java.lang.Object

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

Method Detail

add

public Key.ComplexKey add(java.lang.String... stringKeys)

Add one or more strings to the complex key.

Parameters:

stringKeys - string values to add

Returns:

this ComplexKey to allow chained additions

Since:

2.0.0

add

public Key.ComplexKey add(java.lang.Boolean... booleanKeys)

Add one or more booleans to the complex key.

Parameters:

booleanKeys - boolean values to add

Returns:

this ComplexKey to allow chained additions

Since:

2.0.0

add

public Key.ComplexKey add(java.lang.Number... numberKeys)

Add one or more numbers to the complex key.

Parameters:

numberKeys - numerical values to add

Returns:

this ComplexKey to allow chained additions

Since:

2.0.0

addHighSentinel

public Key.ComplexKey addHighSentinel()

Add the high key sentinel value, which is guaranteed to sort last, to the complex key.

Returns:

this ComplexKey. Note that chained additions are prohibited after calling this method and any subsequent calls to add() will throw an IllegalStateException.

Since:

2.13.0

toJson

public java.lang.String toJson()

Returns:

the JSON string representation of this complex key

Since:

2.0.0

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object