com.allanbank.mongodb.builder

Enum MapReduce.OutputType

java.lang.Object

java.lang.Enum<MapReduce.OutputType>

com.allanbank.mongodb.builder.MapReduce.OutputType

All Implemented Interfaces:

Serializable, Comparable<MapReduce.OutputType>

Enclosing class:

MapReduce

public static enum MapReduce.OutputType
extends Enum<MapReduce.OutputType>

Enumeration of the possible output types.

API Notice:

This enumeration is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2011-2013, Allanbank Consulting, Inc., All Rights Reserved

Enum Constant Summary

Enum Constants

Enum Constant and Description
INLINE Returns the results inline to the reply to the map/reduce command.
MERGE Merges the results of the output collections and the map/reduce results.
REDUCE Runs a second reduce phase across the output collection and the map/reduce results.
REPLACE Replaces the contents of the output collection with the map/reduce results.

Method Summary

Methods

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

INLINE

public static final MapReduce.OutputType INLINE

Returns the results inline to the reply to the map/reduce command.

MERGE

public static final MapReduce.OutputType MERGE

Merges the results of the output collections and the map/reduce results.

REDUCE

public static final MapReduce.OutputType REDUCE

Runs a second reduce phase across the output collection and the map/reduce results.

REPLACE

public static final MapReduce.OutputType REPLACE

Replaces the contents of the output collection with the map/reduce results.

Method Detail

values

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

Returns:

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

valueOf

public static MapReduce.OutputType 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