com.speedment.field.trait

Interface ComparableFieldTrait<ENTITY,D,V extends Comparable<? super V>>

Type Parameters:

ENTITY - the entity type

D - the database type

V - the field value type

All Known Subinterfaces:

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

public interface ComparableFieldTrait<ENTITY,D,V extends Comparable<? super V>>

A representation of an Entity field that is a reference type (e.g. Integer and not int) and that implements Comparable.

Author:

Per Minborg, Emil Forslund

Method Summary

Modifier and Type	Method and Description
default ComparableSpeedmentPredicate<ENTITY,D,V>	between(V start, V end) Returns a Predicate that will evaluate to true, if and only if this Field is between the given values (inclusive the start value but exclusive the end value).
ComparableSpeedmentPredicate<ENTITY,D,V>	between(V start, V end, Inclusion inclusion) Returns a Predicate that will evaluate to true, if and only if this Field is between the given values and taking the Inclusion parameter into account when determining if either of the end points shall be included in the Field range or not.
Comparator<ENTITY>	comparator() Returns a Comparator that will compare to this field using this fields natural order.
Comparator<ENTITY>	comparatorNullFieldsFirst() Returns a Comparator that will compare to this field using this fields natural order, null fields are sorted first.
Comparator<ENTITY>	comparatorNullFieldsLast() Returns a Comparator that will compare to this field using this fields natural order, null fields are sorted last.
ComparableSpeedmentPredicate<ENTITY,D,V>	equal(V value) Returns a Predicate that will evaluate to true, if and only if this Field is equal to the given value.
ComparableSpeedmentPredicate<ENTITY,D,V>	greaterOrEqual(V value) Returns a Predicate that will evaluate to true, if and only if this Field is greater than or equal to the given value.
ComparableSpeedmentPredicate<ENTITY,D,V>	greaterThan(V value) Returns a Predicate that will evaluate to true, if and only if this Field is greater than the given value.
ComparableSpeedmentPredicate<ENTITY,D,V>	in(Set<V> values) Returns a Predicate that will evaluate to true, if and only if this Field is in the given Set.
ComparableSpeedmentPredicate<ENTITY,D,V>	in(V... values) Returns a Predicate that will evaluate to true, if and only if this Field is in the set of given values.
ComparableSpeedmentPredicate<ENTITY,D,V>	lessOrEqual(V value) Returns a Predicate that will evaluate to true, if and only if this Field is less than or equal to the given value.
ComparableSpeedmentPredicate<ENTITY,D,V>	lessThan(V value) Returns a Predicate that will evaluate to true, if and only if this Field is less than the given value.
default ComparableSpeedmentPredicate<ENTITY,D,V>	notBetween(V start, V end) Returns a Predicate that will evaluate to true, if and only if this Field is not between the given values (inclusive the start value but exclusive the end value).
ComparableSpeedmentPredicate<ENTITY,D,V>	notBetween(V start, V end, Inclusion inclusion) Returns a Predicate that will evaluate to true, if and only if this Field is not between the given values and taking the Inclusion parameter into account when determining if either of the end points shall be included in the Field range or not.
ComparableSpeedmentPredicate<ENTITY,D,V>	notEqual(V value) Returns a Predicate that will evaluate to true, if and only if this Field is not equal to the given value.
ComparableSpeedmentPredicate<ENTITY,D,V>	notIn(Set<V> values) Returns a Predicate that will evaluate to true, if and only if this Field is not in the given Set.
ComparableSpeedmentPredicate<ENTITY,D,V>	notIn(V... values) Returns a Predicate that will evaluate to true, if and only if this Field is not in the set of given values.

Method Detail

comparator

Comparator<ENTITY> comparator()

Returns a Comparator that will compare to this field using this fields natural order.

Returns:

a Comparator that will compare to this field using this fields natural order

Throws:

NullPointerException - if a field is null

comparatorNullFieldsFirst

Comparator<ENTITY> comparatorNullFieldsFirst()

Returns a Comparator that will compare to this field using this fields natural order, null fields are sorted first.

Returns:

a Comparator that will compare to this field using this fields natural order, null fields are sorted first

comparatorNullFieldsLast

Comparator<ENTITY> comparatorNullFieldsLast()

Returns a Comparator that will compare to this field using this fields natural order, null fields are sorted last.

Returns:

a Comparator that will compare to this field using this fields natural order, null fields are sorted last

equal

ComparableSpeedmentPredicate<ENTITY,D,V> equal(V value)

Returns a Predicate that will evaluate to true, if and only if this Field is equal to the given value.

Parameters:

value - to compare

Returns:

a Predicate that will evaluate to true, if and only if this Field is equal to the given value

notEqual

ComparableSpeedmentPredicate<ENTITY,D,V> notEqual(V value)

Returns a Predicate that will evaluate to true, if and only if this Field is not equal to the given value.

Parameters:

value - to compare

Returns:

a Predicate that will evaluate to true, if and only if this Field is not equal to the given value

lessThan

ComparableSpeedmentPredicate<ENTITY,D,V> lessThan(V value)

Returns a Predicate that will evaluate to true, if and only if this Field is less than the given value.

Parameters:

value - to compare

Returns:

a Predicate that will evaluate to true, if and only if this Field is less than the given value

lessOrEqual

ComparableSpeedmentPredicate<ENTITY,D,V> lessOrEqual(V value)

Returns a Predicate that will evaluate to true, if and only if this Field is less than or equal to the given value.

Parameters:

value - to compare

Returns:

a Predicate that will evaluate to true, if and only if this Field is less than or equal to the given value

greaterThan

ComparableSpeedmentPredicate<ENTITY,D,V> greaterThan(V value)

Returns a Predicate that will evaluate to true, if and only if this Field is greater than the given value.

Parameters:

value - to compare

Returns:

a Predicate that will evaluate to true, if and only if this Field is greater than the given value

greaterOrEqual

ComparableSpeedmentPredicate<ENTITY,D,V> greaterOrEqual(V value)

Returns a Predicate that will evaluate to true, if and only if this Field is greater than or equal to the given value.

Parameters:

value - to compare

Returns:

a Predicate that will evaluate to true, if and only if this Field is greater than or equal to the given value

between

default ComparableSpeedmentPredicate<ENTITY,D,V> between(V start,
                                                         V end)

Returns a Predicate that will evaluate to true, if and only if this Field is between the given values (inclusive the start value but exclusive the end value).

N.B. if the start value is greater than the end value, then the returned Predicate will always evaluate to false

Parameters:

start - to compare as a start value

end - to compare as an end value

Returns:

a Predicate that will evaluate to true, if and only if this Field is between the given values (inclusive the start value but exclusive the end value)

between

ComparableSpeedmentPredicate<ENTITY,D,V> between(V start,
                                                 V end,
                                                 Inclusion inclusion)

Returns a Predicate that will evaluate to true, if and only if this Field is between the given values and taking the Inclusion parameter into account when determining if either of the end points shall be included in the Field range or not.

N.B. if the start value is greater than the end value, then the returned Predicate will always evaluate to false

Parameters:

start - to compare as a start value

end - to compare as an end value

inclusion - determines if the end points is included in the Field range.

Returns:

a Predicate that will evaluate to true, if and only if this Field is between the given values and taking the Inclusion parameter into account when determining if either of the end points shall be included in the Field range or not

notBetween

default ComparableSpeedmentPredicate<ENTITY,D,V> notBetween(V start,
                                                            V end)

Returns a Predicate that will evaluate to true, if and only if this Field is not between the given values (inclusive the start value but exclusive the end value).

N.B. if the start value is greater than the end value, then the returned Predicate will always evaluate to true

Parameters:

start - to compare as a start value

end - to compare as an end value

Returns:

a Predicate that will evaluate to true, if and only if this Field is not between the given values (inclusive the start value but exclusive the end value)

notBetween

ComparableSpeedmentPredicate<ENTITY,D,V> notBetween(V start,
                                                    V end,
                                                    Inclusion inclusion)

Returns a Predicate that will evaluate to true, if and only if this Field is not between the given values and taking the Inclusion parameter into account when determining if either of the end points shall be included in the Field range or not.

N.B. if the start value is greater than the end value, then the returned Predicate will always evaluate to true

Parameters:

start - to compare as a start value

end - to compare as an end value

inclusion - determines if the end points is included in the Field range.

Returns:

a Predicate that will evaluate to true, if and only if this Field is not between the given values and taking the Inclusion parameter into account when determining if either of the end points shall be included in the Field range or not

in

ComparableSpeedmentPredicate<ENTITY,D,V> in(V... values)

Returns a Predicate that will evaluate to true, if and only if this Field is in the set of given values.

N.B. if no values are given, then the returned Predicate will always evaluate to false

Parameters:

values - the set of values to match towards this Field

Returns:

a Predicate that will evaluate to true, if and only if this Field is in the set of given values

in

ComparableSpeedmentPredicate<ENTITY,D,V> in(Set<V> values)

Returns a Predicate that will evaluate to true, if and only if this Field is in the given Set.

N.B. if the Set is empty, then the returned Predicate will always evaluate to false

Parameters:

values - the set of values to match towards this Field

Returns:

a Predicate that will evaluate to true, if and only if this Field is in the given Set

notIn

ComparableSpeedmentPredicate<ENTITY,D,V> notIn(V... values)

Returns a Predicate that will evaluate to true, if and only if this Field is not in the set of given values.

N.B. if no values are given, then the returned Predicate will always evaluate to true

Parameters:

values - the set of values to match towards this Field

Returns:

a Predicate that will evaluate to true, if and only if this Field is not in the set of given values

notIn

ComparableSpeedmentPredicate<ENTITY,D,V> notIn(Set<V> values)

Returns a Predicate that will evaluate to true, if and only if this Field is not in the given Set.

N.B. if the Set is empty, then the returned Predicate will always evaluate to true

Parameters:

values - the set of values to match towards this Field

Returns:

a Predicate that will evaluate to true, if and only if this Field is not in the given Set