Package com.blazebit.persistence.view.spi.type

Class AbstractMutableBasicUserType<X>

java.lang.Object

com.blazebit.persistence.view.spi.type.AbstractMutableBasicUserType<X>

Type Parameters:

X - The type of the user type

All Implemented Interfaces:

BasicUserType<X>

Direct Known Subclasses:

MutableBasicUserType

public abstract class AbstractMutableBasicUserType<X>
extends java.lang.Object
implements BasicUserType<X>

A base class for implementing basic user types for non-entity mutable types.

Since:

1.2.0

Author:

Christian Beikov

Field Summary

Fields inherited from interface com.blazebit.persistence.view.spi.type.BasicUserType

DIRTY_MARKER

Constructor Summary

Constructors

Constructor	Description
AbstractMutableBasicUserType()

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	getDirtyProperties(X entity)	Returns the nested properties of the object that are known to be dirty.
int	hashCode(X object)	Returns the hash code of the object for lookups in hash based collections.
boolean	isDeepEqual(X object1, X object2)	Returns true if the given objects are equal regarding their values.
boolean	isEqual(X initial, X current)	Returns true if the given objects are equal regarding their identity.
boolean	isMutable()	Returns true if the type is mutable, false otherwise.
boolean	shouldPersist(X entity)	Returns true if the given entity object should be persisted.
boolean	supportsDeepCloning()	Returns true if the type supports creating deep clones, false otherwise.
boolean	supportsDeepEqualChecking()	Returns true if the type supports checking deep equality, false otherwise.
boolean	supportsDirtyChecking()	Returns true if the type supports dirty checking, false otherwise.
boolean	supportsDirtyTracking()	Returns true if the type supports dirty tracking, false otherwise.

Methods inherited from interface com.blazebit.persistence.view.spi.type.BasicUserType

deepClone

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMutableBasicUserType

public AbstractMutableBasicUserType()

Method Detail

isMutable

public boolean isMutable()

Description copied from interface: BasicUserType

Returns true if the type is mutable, false otherwise.

Specified by:

isMutable in interface BasicUserType<X>

Returns:

true if mutable, false otherwise

supportsDeepEqualChecking

public boolean supportsDeepEqualChecking()

Description copied from interface: BasicUserType

Returns true if the type supports checking deep equality, false otherwise. Deep equality checking, in contrast to normal equality checking, compares objects by their actual values rather than maybe just their identity. For value types, deep equality checking is the same as normal equality checking.

Specified by:

supportsDeepEqualChecking in interface BasicUserType<X>

Returns:

true if deep equality checking is supported, false otherwise

supportsDeepCloning

public boolean supportsDeepCloning()

Description copied from interface: BasicUserType

Returns true if the type supports creating deep clones, false otherwise. Deep clones are only necessary for mutable types that don't support dirty checking. Immutable types can simply return true.

Specified by:

supportsDeepCloning in interface BasicUserType<X>

Returns:

true if deep cloning is supported, false otherwise

isEqual

public boolean isEqual(X initial,
                       X current)

Description copied from interface: BasicUserType

Returns true if the given objects are equal regarding their identity. For value types, this is the same as deep equality checking.

Specified by:

isEqual in interface BasicUserType<X>

Parameters:

initial - The first object

current - The second object

Returns:

true if the objects are equal, false otherwise

isDeepEqual

public boolean isDeepEqual(X object1,
                           X object2)

Description copied from interface: BasicUserType

Returns true if the given objects are equal regarding their values. If deep equality is not supported, returns false.

Specified by:

isDeepEqual in interface BasicUserType<X>

Parameters:

object1 - The first object

object2 - The second object

Returns:

true if the objects are equal, false otherwise

hashCode

public int hashCode(X object)

Description copied from interface: BasicUserType

Returns the hash code of the object for lookups in hash based collections.

Specified by:

hashCode in interface BasicUserType<X>

Parameters:

object - The object

Returns:

the hash code of the object

supportsDirtyChecking

public boolean supportsDirtyChecking()

Description copied from interface: BasicUserType

Returns true if the type supports dirty checking, false otherwise. This is only relevant when the type is also mutable.

Specified by:

supportsDirtyChecking in interface BasicUserType<X>

Returns:

true if dirty checking is supported, false otherwise

supportsDirtyTracking

public boolean supportsDirtyTracking()

Description copied from interface: BasicUserType

Returns true if the type supports dirty tracking, false otherwise. Support for dirty tracking implies that the type implements the BasicDirtyTracker interface. This is only relevant when the type is also mutable. Note that if this method returns true, the BasicUserType.supportsDirtyChecking() method should also return true.

Specified by:

supportsDirtyTracking in interface BasicUserType<X>

Returns:

true if dirty tracking is supported, false otherwise

shouldPersist

public boolean shouldPersist(X entity)

Description copied from interface: BasicUserType

Returns true if the given entity object should be persisted. This is invoked for user types where the type T is an entity type. If the type is not an entity type, returns false.

Specified by:

shouldPersist in interface BasicUserType<X>

Parameters:

entity - The entity for which to determine whether it should be persisted

Returns:

true if the entity should be persisted, false otherwise

getDirtyProperties

public java.lang.String[] getDirtyProperties(X entity)

Description copied from interface: BasicUserType

Returns the nested properties of the object that are known to be dirty. If the object isn't dirty i.e. doesn't need flushing, null is returned. If the properties that are dirty aren't known or the type doesn't have nested properties, an empty array or BasicUserType.DIRTY_MARKER is returned.

Specified by:

getDirtyProperties in interface BasicUserType<X>

Parameters:

entity - The object for which to determine the dirty properties

Returns:

the dirty properties of the object