com.adobe.cq.social.ugc.api

Class PathConstraint

java.lang.Object

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

com.adobe.cq.social.ugc.api.PathConstraint

All Implemented Interfaces:

Constraint

public class PathConstraint
extends AbstractConstraint
implements Constraint

PathConstraint defines a constraint on the path of a node. The type of the path constraint is defined by the PathConstraintType enum.

Constructor Summary

Constructors

Constructor and Description
PathConstraint(java.lang.String path, PathConstraintType pathConstraintType) Creates a new instance of PathConstraint with the given path, path constraint and an AND operator.
PathConstraint(java.lang.String path, PathConstraintType pathConstraintType, Operator operator) Creates a new instance of PathConstraint.

Method Summary

Modifier and Type	Method and Description
void	accept(ConstraintVisitor constraintVisitor) Accepts a ConstraintVisitor so that it may travers a constraint hierarchy.
java.lang.String	getPath() Gets the path for this constraint.
PathConstraintType	getPathConstraintType() Gets the type of constraint being placed on the path.
void	setPath(java.lang.String path) Sets the path for this constraint.

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

PathConstraint

public PathConstraint(java.lang.String path,
                      PathConstraintType pathConstraintType)

Creates a new instance of PathConstraint with the given path, path constraint and an AND operator.

Parameters:

path - String containing the path for this constraint.

pathConstraintType - PathConstraintType defining the type of constraint being based on the path.

PathConstraint

public PathConstraint(java.lang.String path,
                      PathConstraintType pathConstraintType,
                      Operator operator)

Creates a new instance of PathConstraint.

Parameters:

path - String containing the path for this constraint.

pathConstraintType - PathConstraintType defining the type of constraint being based on the path.

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

Method Detail

getPathConstraintType

public PathConstraintType getPathConstraintType()

Gets the type of constraint being placed on the path.

Returns:

PathConstraintType defining what kind of constraint is being placed on the path.

getPath

public java.lang.String getPath()

Gets the path for this constraint.

Returns:

String containing the path for this constraint.

setPath

public void setPath(java.lang.String path)

Sets the path for this constraint. Used when mapping a path having /content constraint to a UGC constraint

Parameters:

path - path

accept

public void accept(ConstraintVisitor constraintVisitor)

Accepts a ConstraintVisitor so that it may travers a constraint hierarchy.

Specified by:

accept in interface Constraint

Parameters:

constraintVisitor - ConstraintVisitor to accept.