org.springframework.data.mongodb.core.aggregation
Class ExposedFields

java.lang.Object
  org.springframework.data.mongodb.core.aggregation.ExposedFields

All Implemented Interfaces:

Iterable<org.springframework.data.mongodb.core.aggregation.ExposedFields.ExposedField>

public class ExposedFields
extends Object
implements Iterable<org.springframework.data.mongodb.core.aggregation.ExposedFields.ExposedField>

Value object to capture the fields exposed by an AggregationOperation.

Since:

1.3

Author:

Oliver Gierke

Method Summary

ExposedFields	and(org.springframework.data.mongodb.core.aggregation.ExposedFields.ExposedField field) Creates a new ExposedFields adding the given ExposedFields.ExposedField.
boolean	exposesSingleFieldOnly() Returns whether the ExposedFields exposes a single field only.
static ExposedFields	from(org.springframework.data.mongodb.core.aggregation.ExposedFields.ExposedField... fields) Creates a new ExposedFields instance from the given ExposedFields.ExposedFields.
org.springframework.data.mongodb.core.aggregation.ExposedFields.ExposedField	getField(String name) Returns the field with the given name or null if no field with the given name is available.
Iterator<org.springframework.data.mongodb.core.aggregation.ExposedFields.ExposedField>	iterator()
static ExposedFields	nonSynthetic(Fields fields) Creates non-synthetic ExposedFields from the given Fields.
static ExposedFields	synthetic(Fields fields) Creates synthetic ExposedFields from the given Fields.

Methods inherited from class java.lang.Object

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

Method Detail

from

public static ExposedFields from(org.springframework.data.mongodb.core.aggregation.ExposedFields.ExposedField... fields)

Creates a new ExposedFields instance from the given ExposedFields.ExposedFields.

Parameters:

fields - must not be null.

Returns:

synthetic

public static ExposedFields synthetic(Fields fields)

Creates synthetic ExposedFields from the given Fields.

Parameters:

fields - must not be null.

Returns:

nonSynthetic

public static ExposedFields nonSynthetic(Fields fields)

Creates non-synthetic ExposedFields from the given Fields.

Parameters:

fields - must not be null.

Returns:

and

public ExposedFields and(org.springframework.data.mongodb.core.aggregation.ExposedFields.ExposedField field)

Creates a new ExposedFields adding the given ExposedFields.ExposedField.

Parameters:

field - must not be null.

Returns:

getField

public org.springframework.data.mongodb.core.aggregation.ExposedFields.ExposedField getField(String name)

Returns the field with the given name or null if no field with the given name is available.

Parameters:

name -

Returns:

exposesSingleFieldOnly

public boolean exposesSingleFieldOnly()

Returns whether the ExposedFields exposes a single field only.

Returns:

iterator

public Iterator<org.springframework.data.mongodb.core.aggregation.ExposedFields.ExposedField> iterator()

Specified by:

iterator in interface Iterable<org.springframework.data.mongodb.core.aggregation.ExposedFields.ExposedField>