org.ofbiz.service.calendar
Class TemporalExpressions.MonthRange

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

public static class TemporalExpressions.MonthRange
extends TemporalExpression

A temporal expression that represents a month range.

See Also:
Serialized Form

Field Summary
protected  int end
           
protected  int start
           
 
Fields inherited from class org.ofbiz.service.calendar.TemporalExpression
id, sequence, subSequence
 
Constructor Summary
TemporalExpressions.MonthRange(int start, int end)
           
 
Method Summary
 void accept(TemporalExpressionVisitor visitor)
          Handles a TemporalExpressionVisitor visit.
 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 getEndMonth()
          Returns the ending month of this range.
 int getStartMonth()
          Returns the starting month of this range.
 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

start

protected final int start

end

protected final int end
Constructor Detail

TemporalExpressions.MonthRange

public TemporalExpressions.MonthRange(int start,
                                      int end)
Parameters:
start - An integer in the range of Calendar.JANUARY to Calendar.UNDECIMBER
end - An integer in the range of Calendar.JANUARY to Calendar.UNDECIMBER
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

getStartMonth

public int getStartMonth()
Returns the starting month of this range.

Returns:
The starting month of this range

getEndMonth

public int getEndMonth()
Returns the ending month of this range.

Returns:
The ending month of this range