Package org.springframework.data.mongodb.core.mapping

Class MongoField.MongoFieldBuilder

java.lang.Object

org.springframework.data.mongodb.core.mapping.MongoField.MongoFieldBuilder

Enclosing class:

MongoField

public static class MongoField.MongoFieldBuilder
extends Object

Builder for MongoField.

Constructor Summary

Constructors

Constructor	Description
MongoFieldBuilder()

Method Summary

Modifier and Type	Method	Description
MongoField	build()	Build a new MongoField.
MongoField.MongoFieldBuilder	fieldType(FieldType fieldType)	Configure the field type.
MongoField.MongoFieldBuilder	name(String fieldName)	Configure the field name as key.
MongoField.MongoFieldBuilder	order(int order)	Configure the field order, defaulting to Integer.MAX_VALUE (undefined).
MongoField.MongoFieldBuilder	path(String path)	Configure the field name as path.

Methods inherited from class java.lang.Object

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

Constructor Details

MongoFieldBuilder

public MongoFieldBuilder()

Method Details

fieldType

public MongoField.MongoFieldBuilder fieldType(FieldType fieldType)

Configure the field type.

Parameters:

fieldType -

Returns:

name

public MongoField.MongoFieldBuilder name(String fieldName)

Configure the field name as key. Key field names are used as-is without applying path segmentation splitting rules.

Parameters:

fieldName -

Returns:

path

public MongoField.MongoFieldBuilder path(String path)

Configure the field name as path. Path field names are applied as paths potentially pointing into subdocuments.

Parameters:

path -

Returns:

order

public MongoField.MongoFieldBuilder order(int order)

Configure the field order, defaulting to Integer.MAX_VALUE (undefined).

Parameters:

order -

Returns:

build

public MongoField build()

Build a new MongoField.

Returns:

a new MongoField.