Package com.mongodb.client.model.fill

Interface FillOutputField

All Superinterfaces:

Bson

All Known Subinterfaces:

LinearFillOutputField, LocfFillOutputField, ValueFillOutputField

@Evolving
public interface FillOutputField
extends Bson

The core part of the $fill pipeline stage of an aggregation pipeline. A pair of an expression/method and a path to a field to be filled with evaluation results of the expression/method.

Since:

4.7

See Also:

• Aggregates.fill(FillOptions, Iterable)
• Aggregates.fill(FillOptions, FillOutputField, FillOutputField...)

Since server release

5.3

Field Summary

Fields inherited from interface org.bson.conversions.Bson

DEFAULT_CODEC_REGISTRY

Method Summary

Static Methods

Modifier and Type	Method	Description
static LinearFillOutputField	linear(String field)	Returns a FillOutputField that uses the linear method.
static LocfFillOutputField	locf(String field)	Returns a FillOutputField that uses the locf method.
static FillOutputField	of(Bson fill)	Creates a FillOutputField from a Bson in situations when there is no builder method that better satisfies your needs.
static <TExpression> ValueFillOutputField	value(String field, TExpression expression)	Returns a FillOutputField that uses the specified expression.

Methods inherited from interface org.bson.conversions.Bson

toBsonDocument, toBsonDocument

Method Details

value

static <TExpression> ValueFillOutputField value(String field,
 TExpression expression)

Returns a FillOutputField that uses the specified expression.

Type Parameters:

TExpression - The expression type.

Parameters:

field - The field to fill.

expression - The expression.

Returns:

The requested FillOutputField.

MongoDB documentation

Dot notation

locf

static LocfFillOutputField locf(String field)

Returns a FillOutputField that uses the locf method.

Parameters:

field - The field to fill.

Returns:

The requested FillOutputField.

MongoDB documentation

Dot notation

linear

static LinearFillOutputField linear(String field)

Returns a FillOutputField that uses the linear method.

Sorting is required.

Parameters:

field - The field to fill.

Returns:

The requested FillOutputField.

MongoDB documentation

Dot notation

of

static FillOutputField of(Bson fill)

Creates a FillOutputField from a Bson in situations when there is no builder method that better satisfies your needs. This method cannot be used to validate the syntax.

Example
The following code creates two functionally equivalent FillOutputFields, though they may not be equal.

  FillOutputField field1 = FillOutputField.locf("fieldName");
  FillOutputField field2 = FillOutputField.of(new Document("fieldName", new Document("method", "locf")));
 

Parameters:

fill - A Bson representing the required FillOutputField.

Returns:

The requested FillOutputField.