net.sf.mmm.util.query.api.argument

Interface Argument<V>

Type Parameters:

V - the generic type of the value to check by the Expression to build.

All Known Subinterfaces:

AbstractArgument<V>, AbstractBooleanArgument, AbstractCollectionArgument<V,E>, AbstractComparableArgument<V>, AbstractEntityBeanArgument<V>, AbstractListArgument<E>, AbstractMapArgument<K,V>, AbstractNumberArgument<V>, AbstractSetArgument<E>, AbstractStringArgument, BooleanArgument, BooleanPath, CollectionArgument<V,E>, CollectionPath<V,E>, ComparableArgument<V>, ComparablePath<V>, EntityBeanArgument<V>, EntityBeanPath<V>, ListArgument<E>, ListPath<E>, MapArgument<K,V>, MapPath<K,V>, NumberArgument<V>, NumberPath<V>, Path<V>, SetArgument<E>, SetPath<E>, StringArgument, StringPath

All Known Implementing Classes:

BooleanPathImpl, CollectionPathImpl, ComparablePathImpl, ConstantArgument, ConstantBooleanArgument, ConstantCollectionArgument, ConstantComparableArgument, ConstantEntityBeanArgument, ConstantListArgument, ConstantMapArgument, ConstantNumberArgument, ConstantSetArgument, ConstantStringArgument, EntityBeanPathImpl, ListPathImpl, MapPathImpl, NumberPathImpl, PathImpl, SetPathImpl, StringPathImpl

public interface Argument<V>

This is the interface for a builder of an Expression checking one argument or comparing two arguments.

Since:

8.0.0

Author:

hohwille

See Also:

Args, Path

Method Summary

Modifier and Type	Method and Description
Expression	eq(Path<V> property)
Expression	eq(V value)
default V	evaluate()
V	getValue()
Path<V>	getValuePath()
Expression	in(Collection<? extends V> values)
Expression	in(V... values)
default boolean	isConstant()
Expression	isNotNull()
Expression	isNull()
Expression	neq(Path<V> property)
Expression	neq(V value)
Expression	notIn(Collection<? extends V> values)
Expression	notIn(V... values)

Method Detail

getValuePath

Path<V> getValuePath()

Returns:

the Path of this builder. Will be null if value is NOT null and vice versa.

getValue

V getValue()

Returns:

the literal value of this Argument. Will be null if path is NOT null and vice versa.

evaluate

default V evaluate()

Returns:

the value of this Argument.

eq

Expression eq(V value)

Parameters:

value - the value to compare.

Returns:

an Expression for this == value.

eq

Expression eq(Path<V> property)

Parameters:

property - the path to compare.

Returns:

an Expression for this == property.

neq

Expression neq(V value)

Parameters:

value - the value to compare.

Returns:

an Expression for this != value.

neq

Expression neq(Path<V> property)

Parameters:

property - the path to compare.

Returns:

an Expression for this != property.

isNull

Expression isNull()

Returns:

an Expression for this IS NULL.

isNotNull

Expression isNotNull()

Returns:

an Expression for this IS NOT NULL.

in

Expression in(Collection<? extends V> values)

Parameters:

values - the Collection with the values the Argument shall be contained in.

Returns:

an Expression for this IN (values).

in

Expression in(V... values)

Parameters:

values - the array with the values the Argument shall be contained in.

Returns:

an Expression for this IN (values).

notIn

Expression notIn(Collection<? extends V> values)

Parameters:

values - the Collection with the values the Argument shall NOT be contained in.

Returns:

an Expression for this NOT IN (values).

notIn

Expression notIn(V... values)

Parameters:

values - the array with the values the Argument shall NOT be contained in.

Returns:

an Expression for this NOT IN (values).

isConstant

default boolean isConstant()

Returns:

true if this is a literal value Argument, false otherwise.