Package org.apache.ofbiz.service.calendar

Class TemporalExpressions.Substitution

java.lang.Object

org.apache.ofbiz.service.calendar.TemporalExpression

org.apache.ofbiz.service.calendar.TemporalExpressions.Substitution

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TemporalExpression>

Enclosing class:

TemporalExpressions

public static class TemporalExpressions.Substitution
extends TemporalExpression

A temporal expression that provides a substitution for an excluded temporal expression.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.ofbiz.service.calendar.TemporalExpression

TemporalExpression.ExpressionContext

Field Summary

Fields

Modifier and Type	Field	Description
protected TemporalExpression	excluded
protected TemporalExpression	included
static java.lang.String	module
protected TemporalExpression	substitute

Fields inherited from class org.apache.ofbiz.service.calendar.TemporalExpression

id, sequence

Constructor Summary

Constructors

Constructor	Description
Substitution(TemporalExpression included, TemporalExpression excluded, TemporalExpression substitute)

Method Summary

Modifier and Type	Method	Description
void	accept(TemporalExpressionVisitor visitor)	Handles a TemporalExpressionVisitor visit.
protected boolean	containsExpression(TemporalExpression expression)
boolean	equals(java.lang.Object obj)
com.ibm.icu.util.Calendar	first(com.ibm.icu.util.Calendar cal)	Returns a date representing the first occurrence of this expression on or after a specified date.
TemporalExpression	getExcluded()	Returns the excluded expression.
TemporalExpression	getIncluded()	Returns the included expression.
TemporalExpression	getSubstitute()	Returns the substitute expression.
int	hashCode()
boolean	includesDate(com.ibm.icu.util.Calendar cal)	Returns true if this expression includes the specified date.
boolean	isSubstitutionCandidate(com.ibm.icu.util.Calendar cal, TemporalExpression expressionToTest)	Returns true if this expression is a candidate for substitution using the expression expressionToTest for the date cal.
com.ibm.icu.util.Calendar	next(com.ibm.icu.util.Calendar cal, TemporalExpression.ExpressionContext context)
java.lang.String	toString()

Methods inherited from class org.apache.ofbiz.service.calendar.TemporalExpression

compareTo, getId, getRange, next, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

module

public static final java.lang.String module

excluded

protected final TemporalExpression excluded

included

protected final TemporalExpression included

substitute

protected final TemporalExpression substitute

Constructor Detail

Substitution

public Substitution(TemporalExpression included,
                    TemporalExpression excluded,
                    TemporalExpression substitute)

Method Detail

accept

public void accept(TemporalExpressionVisitor visitor)

Description copied from class: TemporalExpression

Handles a TemporalExpressionVisitor visit.

Specified by:

accept in class TemporalExpression

containsExpression

protected boolean containsExpression(TemporalExpression expression)

Overrides:

containsExpression in class TemporalExpression

hashCode

public int hashCode()

Overrides:

hashCode in class TemporalExpression

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class TemporalExpression

first

public com.ibm.icu.util.Calendar first(com.ibm.icu.util.Calendar cal)

Description copied from class: TemporalExpression

Returns a date representing the first occurrence of this expression on or after a specified date. Returns null if there is no matching date.

Specified by:

first in class TemporalExpression

Parameters:

cal - A date to evaluate

Returns:

A Calendar instance representing the first matching date, or null if no matching date is found

getExcluded

public TemporalExpression getExcluded()

Returns the excluded expression.

Returns:

The excluded TemporalExpression

getIncluded

public TemporalExpression getIncluded()

Returns the included expression.

Returns:

The included TemporalExpression

getSubstitute

public TemporalExpression getSubstitute()

Returns the substitute expression.

Returns:

The substitute TemporalExpression

includesDate

public boolean includesDate(com.ibm.icu.util.Calendar cal)

Description copied from class: TemporalExpression

Returns true if this expression includes the specified date.

Specified by:

includesDate in class TemporalExpression

Parameters:

cal - A date to evaluate

Returns:

true if this expression includes the date represented by cal

isSubstitutionCandidate

public boolean isSubstitutionCandidate(com.ibm.icu.util.Calendar cal,
                                       TemporalExpression expressionToTest)

Description copied from class: TemporalExpression

Returns true if this expression is a candidate for substitution using the expression expressionToTest for the date cal. A Substitution object will call this method when it needs to know if this expression could have produced the date cal based on the expression expressionToTest.

Specified by:

isSubstitutionCandidate in class TemporalExpression

Parameters:

cal - A date to evaluate

expressionToTest - An expression to evaluate

Returns:

true if this expression could have produced the date cal using the expression expressionToTest

next

public com.ibm.icu.util.Calendar next(com.ibm.icu.util.Calendar cal,
                                      TemporalExpression.ExpressionContext context)

Specified by:

next in class TemporalExpression

toString

public java.lang.String toString()

Overrides:

toString in class TemporalExpression