com.couchbase.client.protocol.views
Enum OnError

java.lang.Object
  extended by java.lang.Enum<OnError>
      extended by com.couchbase.client.protocol.views.OnError
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<OnError>

public enum OnError
extends java.lang.Enum<OnError>

Possible on_error arguments to view queries. See http://www.couchbase.com/docs/couchbase-manual-2.0/ couchbase-views-writing-querying-errorcontrol.html


Enum Constant Summary
CONTINUE
          Continue processing the query even if errors occur, populating the errors response at the end of the query response.
STOP
          Stop the processing of the view query when an error occurs and populate the errors response with details.
 
Method Summary
static OnError valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static OnError[] 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

STOP

public static final OnError STOP
Stop the processing of the view query when an error occurs and populate the errors response with details.


CONTINUE

public static final OnError CONTINUE
Continue processing the query even if errors occur, populating the errors response at the end of the query response. This is the default if no on_error argument is supplied.

Method Detail

values

public static OnError[] 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 (OnError c : OnError.values())
    System.out.println(c);

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

valueOf

public static OnError valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null


Copyright © 2006-2009 Dustin Sallings, 2009-2012 Couchbase, Inc.