com.adobe.cq.social.ugc.api

Class ValueConstraint<T>

java.lang.Object

com.adobe.cq.social.ugc.api.AbstractConstraint

com.adobe.cq.social.ugc.api.AbstractPropertyConstraint

com.adobe.cq.social.ugc.api.ValueConstraint<T>

Type Parameters:

T - the type of value to be constrained.

All Implemented Interfaces:

Constraint

public class ValueConstraint<T>
extends AbstractPropertyConstraint
implements Constraint

ValueConstraint is a property constraint which restricts the value of a property based on a ComparisonType and a value.

Constructor Summary

Constructors

Constructor and Description
ValueConstraint(java.lang.String name, T value) Creates a new instance of ValueConstraint with the given property name and value.
ValueConstraint(java.lang.String name, T value, ComparisonType comparison) Creates a new instance of ValueConstraint with the given property name, value and comparison type.
ValueConstraint(java.lang.String name, T value, ComparisonType comparison, Operator operator) Creates a new instance of ValueConstraint with the given property name, value and comparison type.

Method Summary

Modifier and Type	Method and Description
void	accept(ConstraintVisitor constraintVisitor) Visit this range constraint.
ComparisonType	getComparison() Gets the kind of comparison to perform when evaluating property values.
T	getValue() Gets the value to use when evaluating property values.
void	setValue(T value) Sets the value to use when evaluating property values.

Methods inherited from class com.adobe.cq.social.ugc.api.AbstractPropertyConstraint

getPropertyName

Methods inherited from class com.adobe.cq.social.ugc.api.AbstractConstraint

getOperator, isNegated, negate, setOperator

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.adobe.cq.social.ugc.api.Constraint

getOperator, isNegated, negate, setOperator

Constructor Detail

ValueConstraint

public ValueConstraint(java.lang.String name,
                       T value)

Creates a new instance of ValueConstraint with the given property name and value. This will create a ValueConstraint which will perform an equals comparison.

Parameters:

name - Name of the property being constrained.

value - Value to compare against the property value.

ValueConstraint

public ValueConstraint(java.lang.String name,
                       T value,
                       ComparisonType comparison)

Creates a new instance of ValueConstraint with the given property name, value and comparison type.

Parameters:

name - Name of the property being constrained.

value - Value to compare against the property value.

comparison - ComparisonType defining the kind of comparison to perform when evaluating property values.

ValueConstraint

public ValueConstraint(java.lang.String name,
                       T value,
                       ComparisonType comparison,
                       Operator operator)

Creates a new instance of ValueConstraint with the given property name, value and comparison type.

Parameters:

name - Name of the property being constrained.

value - Value to compare against the property value.

comparison - ComparisonType defining the kind of comparison to perform when evaluating property values.

operator - Operator defining how this constraint is joined with other constraints.

Method Detail

getComparison

public ComparisonType getComparison()

Gets the kind of comparison to perform when evaluating property values.

Returns:

ComparisonType which defines how property values should be evaluated.

getValue

public T getValue()

Gets the value to use when evaluating property values.

Returns:

Value to use when evaluating property values.

setValue

public void setValue(T value)

Sets the value to use when evaluating property values.

Parameters:

value - Value to use when evaluating property values.

accept

public void accept(ConstraintVisitor constraintVisitor)

Visit this range constraint.

Specified by:

accept in interface Constraint

Parameters:

constraintVisitor - the ConstraintVisitor.