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

Class MongoField

java.lang.Object

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

public class MongoField
extends Object

Value Object for representing a field to read/write within a MongoDB Document.

Since:

4.2

Author:

Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MongoField.MongoFieldBuilder	Builder for MongoField.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MongoField(FieldName name, Class<?> targetFieldType, int fieldOrder)
protected	MongoField(FieldName name, FieldType fieldType, int fieldOrder)

Method Summary

Modifier and Type	Method	Description
static MongoField.MongoFieldBuilder	builder()
boolean	equals(Object o)
static MongoField	fromKey(String name)	Create a new MongoField with given name.
static MongoField	fromPath(String name)	Create a new MongoField with given name.
FieldType	getFieldType()	Get the fields target type if defined.
FieldName	getName()
int	getOrder()	Get the position of the field within the target document.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MongoField

protected MongoField(FieldName name,
 Class<?> targetFieldType,
 int fieldOrder)

MongoField

protected MongoField(FieldName name,
 FieldType fieldType,
 int fieldOrder)

Method Details

fromKey

public static MongoField fromKey(String name)

Create a new MongoField with given name.

Parameters:

name - the name to be used as is (with all its potentially special characters).

Returns:

new instance of MongoField.

fromPath

public static MongoField fromPath(String name)

Create a new MongoField with given name.

Parameters:

name - the name to be used path expression.

Returns:

new instance of MongoField.

builder

public static MongoField.MongoFieldBuilder builder()

Returns:

new instance of MongoField.MongoFieldBuilder.

getName

public FieldName getName()

Returns:

never null.

getOrder

public int getOrder()

Get the position of the field within the target document.

Returns:

Integer.MAX_VALUE if undefined.

getFieldType

public FieldType getFieldType()

Get the fields target type if defined.

Returns:

never null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object