Top Description Methods
org.hibernate.property.access.spi

public Interface Getter

extends Serializable
Known Direct Implementers
org.hibernate.property.access.spi.GetterFieldImpl, org.hibernate.property.access.spi.GetterMethodImpl, org.hibernate.property.access.internal.ChainedPropertyAccessImpl, org.hibernate.property.access.internal.PropertyAccessCompositeUserTypeImpl, org.hibernate.property.access.internal.PropertyAccessEmbeddedImpl.GetterImpl, org.hibernate.property.access.internal.PropertyAccessMapImpl.GetterImpl, org.hibernate.property.access.internal.PropertyAccessStrategyBackRefImpl.GetterImpl, org.hibernate.property.access.internal.PropertyAccessStrategyIndexBackRefImpl.GetterImpl, org.hibernate.property.access.internal.PropertyAccessStrategyNoopImpl.GetterImpl
Imports
java.io.Serializable, java.lang.reflect.Member, .Method, .Type, java.util.Map, org.hibernate.engine.spi.SharedSessionContractImplementor, org.checkerframework.checker.nullness.qual.Nullable
The contract for getting the value of a persistent attribute from its container/owner.
Authors
Gavin King, Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public @Nullable Object

Returns:

The extracted value.
get(Object
The instance containing the property value to be retrieved.
owner)

Get the property value from the given owner instance.

public @Nullable Object

Returns:

The extracted value.
getForInsert(Object
The instance containing the value to be retrieved.
owner, Map<K, V>
a map of merged persistent instances to detached instances
mergeMap, SharedSessionContractImplementor
The session from which this request originated.
session)

Get the property value from the given owner instance.

public @Nullable Member

Returns:

The mapped member, or null.
getMember()

Retrieve the member to which this property maps.

public @Nullable Method

Returns:

The getter method, or null.
getMethod()

Retrieve the getter-method.

public @Nullable String

Returns:

The name of the getter method, or null.
getMethodName()

Retrieve the getter-method name.

public Type

Returns:

The declared java type.
getReturnType()

Retrieve the declared Java type

public Class<?>

Returns:

The declared java type class.
getReturnTypeClass()

Retrieve the declared Java type class

Method Detail

getback to summary
public @Nullable Object get(Object owner)

Get the property value from the given owner instance.

Parameters
owner:Object

The instance containing the property value to be retrieved.

Returns:@Nullable Object

The extracted value.

getForInsertback to summary
public @Nullable Object getForInsert(Object owner, Map<K, V> mergeMap, SharedSessionContractImplementor session)

Get the property value from the given owner instance.

Parameters
owner:Object

The instance containing the value to be retrieved.

mergeMap:Map<K, V>

a map of merged persistent instances to detached instances

session:SharedSessionContractImplementor

The session from which this request originated.

Returns:@Nullable Object

The extracted value.

getMemberback to summary
public @Nullable Member getMember()

Retrieve the member to which this property maps. This might be the field or it might be the getter method.

Optional operation (may return null)

Returns:@Nullable Member

The mapped member, or null.

getMethodback to summary
public @Nullable Method getMethod()

Retrieve the getter-method.

Optional operation (may return null)

Returns:@Nullable Method

The getter method, or null.

getMethodNameback to summary
public @Nullable String getMethodName()

Retrieve the getter-method name.

Optional operation (may return null)

Returns:@Nullable String

The name of the getter method, or null.

getReturnTypeback to summary
public Type getReturnType()

Retrieve the declared Java type

Returns:Type

The declared java type.

getReturnTypeClassback to summary
public Class<?> getReturnTypeClass()

Retrieve the declared Java type class

Returns:Class<?>

The declared java type class.