Module io.ebean.api
Package io.ebean.bean

Interface EntityBean

All Superinterfaces:
Serializable, ToStringAware
public interface EntityBean extends Serializable, ToStringAware
Bean that is aware of EntityBeanIntercept.

This interface and implementation of these methods is added to Entity Beans via instrumentation. These methods have a funny _ebean_ prefix to avoid any clash with normal methods these beans would have. These methods are not for general application consumption.

  • Method Details

    • _ebean_getPropertyNames

      default String[] _ebean_getPropertyNames()
      Return all the property names in defined order.

    • _ebean_getPropertyName

      default String _ebean_getPropertyName(int pos)
      Return the property name at the given position.

    • _ebean_newInstance

      default Object _ebean_newInstance()
      Create and return a new entity bean instance.

    • _ebean_newInstanceReadOnly

      default Object _ebean_newInstanceReadOnly()
      Create and return a new entity bean instance optimised for read only no interception use.

    • _ebean_setEmbeddedLoaded

      default void _ebean_setEmbeddedLoaded()
      Generated method that sets the loaded state on all the embedded beans on this entity bean by using EntityBeanIntercept.setEmbeddedLoaded(Object o);

    • _ebean_isEmbeddedNewOrDirty

      default boolean _ebean_isEmbeddedNewOrDirty()
      Return true if any embedded beans are new or dirty.

    • _ebean_getIntercept

      default EntityBeanIntercept _ebean_getIntercept()
      Return the intercept for this object.

    • _ebean_intercept

      default EntityBeanIntercept _ebean_intercept()
      Similar to _ebean_getIntercept() except it checks to see if the intercept field is null and will create it if required.

      This is really only required when transientInternalFields=true as an enhancement option. In this case the intercept field is transient and will be null after a bean has been deserialised.

      This transientInternalFields=true option was to support some serialization frameworks that can't take into account our ebean fields.

    • _ebean_setField

      default void _ebean_setField(int fieldIndex, Object value)
      Set the value of a field of an entity bean of this type.

      Note that using this method bypasses any interception that otherwise occurs on entity beans. That means lazy loading and oldValues creation.

    • _ebean_setFieldIntercept

      default void _ebean_setFieldIntercept(int fieldIndex, Object value)
      Set the field value with interception.

    • _ebean_getField

      default Object _ebean_getField(int fieldIndex)
      Return the value of a field from an entity bean of this type.

      Note that using this method bypasses any interception that otherwise occurs on entity beans. That means lazy loading.

    • _ebean_getFieldIntercept

      default Object _ebean_getFieldIntercept(int fieldIndex)
      Return the field value with interception.

    • toString

      default void toString(ToStringBuilder builder)
      Description copied from interface: ToStringAware
      Append to the ToStringBuilder.
      Specified by:
      toString in interface ToStringAware