com.couchbase.client.core.service

Enum BucketServiceMapping

java.lang.Object

java.lang.Enum<BucketServiceMapping>

com.couchbase.client.core.service.BucketServiceMapping

All Implemented Interfaces:

Serializable, Comparable<BucketServiceMapping>

public enum BucketServiceMapping
extends Enum<BucketServiceMapping>

Defines the relationship between a bucket and a service.

Since:

1.0

Author:

Michael Nitschinger

Enum Constant Summary

Enum Constants

Enum Constant and Description
ONE_BY_ONE The service can only handle one bucket at a time.
ONE_FOR_ALL The service is able to handle all buckets at the same time.

Method Summary

Modifier and Type	Method and Description
static BucketServiceMapping	valueOf(String name) Returns the enum constant of this type with the specified name.
static BucketServiceMapping[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ONE_FOR_ALL

public static final BucketServiceMapping ONE_FOR_ALL

The service is able to handle all buckets at the same time. This is true for all services where their authentication mechanism is not bound to the connection, but rather to the request object itself.

ONE_BY_ONE

public static final BucketServiceMapping ONE_BY_ONE

The service can only handle one bucket at a time. This is true for all services which have their authentication mechanism bound at connection time, allowing a service not to be reused across buckets.

Method Detail

values

public static BucketServiceMapping[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BucketServiceMapping c : BucketServiceMapping.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BucketServiceMapping valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null