Interface PersistentPropertyCharacteristics

@API(status=STABLE, since="6.3.7") public interface PersistentPropertyCharacteristics
The characteristics of a Neo4jPersistentProperty can diverge from what is by default derived from the annotated classes. Diverging characteristics are requested by the Neo4jMappingContext prior to creating a persistent property. Additional providers of characteristics may be registered with the mapping context.
Since:
6.3.7
Author:
Michael J. Simons

  • Method Details

    • useDefaults

      static PersistentPropertyCharacteristics useDefaults()
      Default characteristics.
      Returns:
      characteristics applying the defaults

    • treatAsTransient

      static PersistentPropertyCharacteristics treatAsTransient()
      Treats the property to which the instance is applied as transient.
      Returns:
      characteristics to treat a property as transient

    • treatAsReadOnly

      static PersistentPropertyCharacteristics treatAsReadOnly()
      Treats the property to which the instance is applied as read only.
      Returns:
      characteristics to treat a property as read only

    • isTransient

      default @Nullable Boolean isTransient()
      Return true to mark a property as transient.
      Returns:
      null to leave the defaults, true or false otherwise

    • isReadOnly

      default @Nullable Boolean isReadOnly()
      Return true to mark a property as read only.
      Returns:
      null to leave the defaults, true or false otherwise