com.allanbank.mongodb.builder

Enum RedactOption

java.lang.Object

java.lang.Enum<RedactOption>

com.allanbank.mongodb.builder.RedactOption

All Implemented Interfaces:

Serializable, Comparable<RedactOption>

public enum RedactOption
extends Enum<RedactOption>

RedactOption provides options for what to do when evaluating a $redact condition within the Aggregate pipeline.

Copyright ©:

2014, Allanbank Consulting, Inc., All Rights Reserved

Enum Constant Summary

Enum Constants

Enum Constant and Description
DESCEND Option for the redact to descend into the sub-documents of the current document.
KEEP Option to keep the current document and not inspect the sub-documents.
PRUNE Option to prune the current document.

Method Summary

Methods

Modifier and Type	Method and Description
String	getToken() Returns the token for the option.
static RedactOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static RedactOption[]	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

DESCEND

public static final RedactOption DESCEND

Option for the redact to descend into the sub-documents of the current document.

KEEP

public static final RedactOption KEEP

Option to keep the current document and not inspect the sub-documents.

PRUNE

public static final RedactOption PRUNE

Option to prune the current document.

Method Detail

values

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

Returns:

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

valueOf

public static RedactOption 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

getToken

public String getToken()

Returns the token for the option.

Returns:

The token for the option.