com.speedment.field.trait

Interface ReferenceFieldTrait<ENTITY,D,V>

Type Parameters:

ENTITY - the entity type

D - the database value type

V - the field value type

All Superinterfaces:

FieldTrait

All Known Subinterfaces:

ComparableField<ENTITY,D,V>, ComparableForeignKeyField<ENTITY,D,V,FK>, ReferenceField<ENTITY,D,V>, ReferenceForeignKeyField<ENTITY,D,V,FK_ENTITY>, StringField<ENTITY,D>, StringForeignKeyField<ENTITY,D,FK_ENTITY>

public interface ReferenceFieldTrait<ENTITY,D,V>
extends FieldTrait

A representation of an Entity field that is a reference type (eg Integer and not int).

Author:

Per Minborg, Emil Forslund

Method Summary

Modifier and Type	Method and Description
default V	get(ENTITY e) Gets the value form the Entity field.
FieldIdentifier<ENTITY>	getIdentifier() Returns the unique identifier of this field.
Getter<ENTITY,V>	getter() Returns a reference to the getter of this field.
SpeedmentPredicate<ENTITY,D,V>	isNotNull() Returns a Predicate that will evaluate to true, if and only if this Field is not null.
SpeedmentPredicate<ENTITY,D,V>	isNull() Returns a Predicate that will evaluate to true, if and only if this Field is null.
default ENTITY	set(ENTITY e, V value) Sets the value in the given Entity
Setter<ENTITY,V>	setter() Returns a reference to the setter for this field.
FieldSetter<ENTITY,V>	setTo(V value) Creates and returns a FieldSetter with a given value.
TypeMapper<D,V>	typeMapper() Returns the type mapper of this field.

Methods inherited from interface com.speedment.field.trait.FieldTrait

findColumn, isUnique

Method Detail

getIdentifier

FieldIdentifier<ENTITY> getIdentifier()

Description copied from interface: FieldTrait

Returns the unique identifier of this field.

Specified by:

getIdentifier in interface FieldTrait

Returns:

the identifier

setter

Setter<ENTITY,V> setter()

Returns a reference to the setter for this field.

Returns:

the setter

getter

Getter<ENTITY,V> getter()

Returns a reference to the getter of this field.

Returns:

the getter

typeMapper

TypeMapper<D,V> typeMapper()

Returns the type mapper of this field.

Returns:

type mapper

get

default V get(ENTITY e)

Gets the value form the Entity field.

Parameters:

e - entity

Returns:

the field value

set

default ENTITY set(ENTITY e,
                   V value)

Sets the value in the given Entity

Parameters:

e - entity

value - to set

Returns:

the entity itself

setTo

FieldSetter<ENTITY,V> setTo(V value)

Creates and returns a FieldSetter with a given value.

Parameters:

value - to set

Returns:

a FieldSetter with a given value

isNull

SpeedmentPredicate<ENTITY,D,V> isNull()

Returns a Predicate that will evaluate to true, if and only if this Field is null.

Returns:

a Predicate that will evaluate to true, if and only if this Field is null

isNotNull

SpeedmentPredicate<ENTITY,D,V> isNotNull()

Returns a Predicate that will evaluate to true, if and only if this Field is not null.

Returns:

a Predicate that will evaluate to true, if and only if this Field is not null