Module spring.data.mongodb

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

Annotation Interface MongoId

@Field
@Retention(RUNTIME)
@Target({FIELD,METHOD,ANNOTATION_TYPE})
public @interface MongoId

MongoId represents a MongoDB specific Id annotation that allows customizing id conversion. Id properties use FieldType.IMPLICIT as the default id's target type. This means that the actual property value is used. No conversion attempts to any other type are made.
In contrast to @Id, String id's are stored as the such even when the actual value represents a valid ObjectId hex String. To trigger String to ObjectId conversion use @MongoId(FieldType.OBJECT_ID).

Since:

2.2

Author:

Christoph Strobl, Mark Paluch

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
FieldType	targetType	Get the preferred _id type to be used.
FieldType	value

Element Details

value

@AliasFor(annotation=Field.class,
          attribute="targetType")
FieldType value

Returns:

the preferred id type.

See Also:

• targetType()

Default:

IMPLICIT

targetType

@AliasFor(annotation=Field.class,
          attribute="targetType")
FieldType targetType

Get the preferred _id type to be used. Defaults to FieldType.IMPLICIT which uses the property's type. If defined different, the given value is attempted to be converted into the desired target type via MongoConverter.convertId(Object, Class).

Returns:

the preferred id type. FieldType.IMPLICIT by default.

Default:

IMPLICIT