com.cloudant.client.api.views

Class Key

java.lang.Object

com.cloudant.client.api.views.Key

public class Key
extends java.lang.Object

Class for specifying the types of keys emitted by a view.

Provides static utilities for generating Key.ComplexKey instances.

Provides access to Key.Type.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Key.ComplexKey Provides methods for adding values to build a complex key array.
static class	Key.ComplexKeyDeserializer GSON deserializer to convert JSON arrays to .ComplexKey
static class	Key.Type<T> Key type identifier.

Constructor Summary

Constructors

Constructor and Description
Key()

Method Summary

Modifier and Type	Method and Description
static Key.ComplexKey	complex(java.lang.Boolean... booleanKeys) Create a new complex key with one or more boolean elements at the start
static Key.ComplexKey	complex(java.lang.Number... numberKeys) Create a new complex key with one or more numerical elements at the start
static Key.ComplexKey	complex(java.lang.String... stringKeys) Create a new complex key with one or more string elements at the start

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Key

public Key()

Method Detail

complex

public static Key.ComplexKey complex(java.lang.Boolean... booleanKeys)

Create a new complex key with one or more boolean elements at the start

Parameters:

booleanKeys - boolean values to add

Returns:

the new ComplexKey

Since:

2.0.0

complex

public static Key.ComplexKey complex(java.lang.Number... numberKeys)

Create a new complex key with one or more numerical elements at the start

Parameters:

numberKeys - numerical values to add

Returns:

the new ComplexKey

Since:

2.0.0

complex

public static Key.ComplexKey complex(java.lang.String... stringKeys)

Create a new complex key with one or more string elements at the start

Parameters:

stringKeys - string values to add

Returns:

the new ComplexKey

Since:

2.0.0