org.ofbiz.service.calendar
Class TemporalExpressions.DayInMonth

java.lang.Object
  extended by org.ofbiz.service.calendar.TemporalExpression
      extended by org.ofbiz.service.calendar.TemporalExpressions.DayInMonth
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<TemporalExpression>
Enclosing class:
TemporalExpressions

public static class TemporalExpressions.DayInMonth
extends TemporalExpression

A temporal expression that represents a day in the month.

See Also:
Serialized Form

Field Summary
protected  int dayOfWeek
           
protected  int occurrence
           
 
Fields inherited from class org.ofbiz.service.calendar.TemporalExpression
id, sequence, subSequence
 
Constructor Summary
TemporalExpressions.DayInMonth(int dayOfWeek, int occurrence)
           
 
Method Summary
 void accept(TemporalExpressionVisitor visitor)
          Handles a TemporalExpressionVisitor visit.
protected  java.util.Calendar alignDayOfWeek(java.util.Calendar cal)
           
 boolean equals(java.lang.Object obj)
           
 java.util.Calendar first(java.util.Calendar cal)
          Returns a date representing the first occurrence of this expression on or after a specified date.
 int getDayOfWeek()
          Returns the day of week in this expression.
 int getOccurrence()
          Returns the occurrence in this expression.
 boolean includesDate(java.util.Calendar cal)
          Returns true if this expression includes the specified date.
 java.util.Calendar next(java.util.Calendar cal)
          Returns a date representing the next occurrence of this expression after a specified date.
 java.lang.String toString()
           
 
Methods inherited from class org.ofbiz.service.calendar.TemporalExpression
compareTo, containsExpression, getId, getRange, setId, setStartOfDay
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

dayOfWeek

protected final int dayOfWeek

occurrence

protected final int occurrence
Constructor Detail

TemporalExpressions.DayInMonth

public TemporalExpressions.DayInMonth(int dayOfWeek,
                                      int occurrence)
Parameters:
dayOfWeek - An integer in the range of Calendar.SUNDAY to Calendar.SATURDAY
occurrence - An integer in the range of -5 to 5, excluding zero
Method Detail

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

includesDate

public boolean includesDate(java.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

first

public java.util.Calendar first(java.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

next

public java.util.Calendar next(java.util.Calendar cal)
Description copied from class: TemporalExpression
Returns a date representing the next occurrence of this expression after a specified date. Returns null if there is no matching date.

Specified by:
next 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

accept

public void accept(TemporalExpressionVisitor visitor)
Description copied from class: TemporalExpression
Handles a TemporalExpressionVisitor visit.

Specified by:
accept in class TemporalExpression

getDayOfWeek

public int getDayOfWeek()
Returns the day of week in this expression.

Returns:
The day of week in this expression

getOccurrence

public int getOccurrence()
Returns the occurrence in this expression.

Returns:
The occurrence in this expression

alignDayOfWeek

protected java.util.Calendar alignDayOfWeek(java.util.Calendar cal)