org.neo4j.ogm.annotation.typeconversion

Annotation Type DateString

@Retention(value=RUNTIME)
 @Target(value=FIELD)
 @Inherited
public @interface DateString

Indicates OGM to store dates as String in ISO_8601 format in the database. Applicable to `java.util.Date` and `java.time.Instant`

Author:

Vince Bickers, Gerrit Meier

Field Summary

Fields

Modifier and Type	Fields and Description
static String	DEFAULT_ZONE_ID
static String	FORMAT
static String	ISO_8601

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	lenient Toggle lenient conversion mode by setting this flag to true (defaults to false).
String	value
String	zoneId Some temporals like Instant, representing an instantaneous point in time cannot be formatted with a given ZoneId.

Field Detail

FORMAT

public static final String FORMAT

ISO_8601

public static final String ISO_8601

DEFAULT_ZONE_ID

public static final String DEFAULT_ZONE_ID

Element Detail

value

public abstract String value

Default:

"yyyy-MM-dd\'T\'HH:mm:ss.SSSXXX"

zoneId

public abstract String zoneId

Some temporals like Instant, representing an instantaneous point in time cannot be formatted with a given ZoneId. In case you want to format an instant or similar with a default pattern, we assume a zone with the given id and default to UTC which is the same assumption that the predefined patterns in DateTimeFormatter take.

Returns:

The zone id to use when applying a custom pattern to an instant temporal.

Default:

"UTC"

lenient

public abstract boolean lenient

Toggle lenient conversion mode by setting this flag to true (defaults to false). Has to be supported by the corresponding converter.

Returns:

flag that represents the desired conversion mode.

Default:

false