com.broadleafcommerce.metadata.dsl.core.extension.conditionals

Interface PropertyConditional<C extends PropertyConditional<C>>

All Superinterfaces:

Conditional<C>, Copyable<C>

All Known Implementing Classes:

DefaultPropertyConditional

public interface PropertyConditional<C extends PropertyConditional<C>>
extends Conditional<C>

An extension of Conditional that is used for checking if a property matches a certain criteria or value. This conditional is useful in scenarios where a property's state is relevant to gate certain functionality.

For example, a conditional that is match when the property "type" has a value of "PRODUCT":

 Conditionals.when("type").equalTo("PRODUCT")
 

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PropertyConditional.DefaultOperators The default set of common supported operators.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Method Summary

Modifier and Type	Method and Description
default C	contains(Object value) Condition is true when the field(java.lang.String) contains the value(java.lang.Object).
default C	containsIgnoreCase(Object value) Condition is true when the field(java.lang.String) contains the value(java.lang.Object) ignoring case.
default C	equalTo(Object value) Condition is true when the field(java.lang.String) is equal to value(java.lang.Object).
default C	exists() Condition is true when the field(java.lang.String) exists.
default C	field(String field) Define the field targeted by this conditional.
String	getField()
String	getOperator()
default String	getType() The type of conditional.
Object	getValue()
default C	greaterThan(Object value) Condition is true when the field(java.lang.String) is greater than value(java.lang.Object).
default C	greaterThanOrEqualTo(Object value) Condition is true when the field(java.lang.String) is greater than or equal to value(java.lang.Object).
default C	lessThan(Object value) Condition is true when the field(java.lang.String) is less than value(java.lang.Object).
default C	lessThanOrEqualTo(Object value) Condition is true when the field(java.lang.String) is less than or equal to value(java.lang.Object).
default C	none() Alias for notExists().
default C	notBlank() Condition is true when the field(java.lang.String) value is not blank.
default C	notContains(Object value) Condition is true when the field(java.lang.String) does not contain the value(java.lang.Object).
default C	notContainsIgnoreCase(Object value) Condition is true when the field(java.lang.String) does not contain the value(java.lang.Object) ignoring case.
default C	notEqualTo(Object value) Condition is true when the field(java.lang.String) is not equal to value(java.lang.Object).
default C	notExists() Condition is true when the field(java.lang.String) does not exist.
default C	operator(String operator) Define the operator for this conditional.
void	setField(String field)
void	setOperator(String operator)
void	setValue(Object value)
default C	value(Object value) Define the value for this conditional.

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Conditional

self, when

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Copyable

copy

Field Detail

TYPE

static final String TYPE

See Also:

Constant Field Values

Method Detail

getType

default String getType()

Description copied from interface: Conditional

The type of conditional. This is used to distinguish different types of conditionals.

Specified by:

getType in interface Conditional<C extends PropertyConditional<C>>

Returns:

the type

getField

String getField()

getOperator

String getOperator()

getValue

@Nullable
Object getValue()

setField

void setField(String field)

setOperator

void setOperator(String operator)

setValue

void setValue(@Nullable
              Object value)

field

default C field(String field)

Define the field targeted by this conditional.

Parameters:

field - the field name

Returns:

this

operator

default C operator(String operator)

Define the operator for this conditional. Typically one of PropertyConditional.DefaultOperators.

Parameters:

operator - the operator

Returns:

this

value

default C value(@Nullable
                Object value)

Define the value for this conditional.

Parameters:

value - the value

Returns:

this

exists

default C exists()

Condition is true when the field(java.lang.String) exists.

Returns:

the conditional

notBlank

default C notBlank()

Condition is true when the field(java.lang.String) value is not blank.

Returns:

the conditional

notExists

default C notExists()

Condition is true when the field(java.lang.String) does not exist.

Returns:

the conditional

none

default C none()

Alias for notExists().

Returns:

the conditional

equalTo

default C equalTo(Object value)

Condition is true when the field(java.lang.String) is equal to value(java.lang.Object).

Returns:

the conditional

notEqualTo

default C notEqualTo(Object value)

Condition is true when the field(java.lang.String) is not equal to value(java.lang.Object).

Returns:

the conditional

greaterThan

default C greaterThan(Object value)

Condition is true when the field(java.lang.String) is greater than value(java.lang.Object).

Returns:

the conditional

greaterThanOrEqualTo

default C greaterThanOrEqualTo(Object value)

Condition is true when the field(java.lang.String) is greater than or equal to value(java.lang.Object).

Returns:

the conditional

lessThan

default C lessThan(Object value)

Condition is true when the field(java.lang.String) is less than value(java.lang.Object).

Returns:

the conditional

lessThanOrEqualTo

default C lessThanOrEqualTo(Object value)

Condition is true when the field(java.lang.String) is less than or equal to value(java.lang.Object).

Returns:

the conditional

contains

default C contains(Object value)

Condition is true when the field(java.lang.String) contains the value(java.lang.Object).

Returns:

the conditional

containsIgnoreCase

default C containsIgnoreCase(Object value)

Condition is true when the field(java.lang.String) contains the value(java.lang.Object) ignoring case.

Returns:

the conditional

notContains

default C notContains(Object value)

Condition is true when the field(java.lang.String) does not contain the value(java.lang.Object).

Returns:

the conditional

notContainsIgnoreCase

default C notContainsIgnoreCase(Object value)

Condition is true when the field(java.lang.String) does not contain the value(java.lang.Object) ignoring case.

Returns:

the conditional