TimePattern (Oracle WebCenter Sites Java API Reference)

java.lang.Object
- COM.FutureTense.Util.TimePattern

All Implemented Interfaces:

Serializable
```
@Exported
public class TimePattern
extends Object
implements Serializable
```
This class represents a scheduled time, using a syntax similar to the UNIX 'cron' syntax. The format is described as follows: hh:mm:ss W/DD/MM hh: 0 - 23 mm: 0 - 59 ss: 0 - 59 W (day of the week): 0 - 6 with 0 = Sunday. DD (day of the month): 1 - 31 MM (month): 1 - 19 Each of these fields may be either an asterisk (meaning all legal values) or a list of elements separated by commas. An element is either a number or two numbers separated by a minus sign indicating an inclusive range. For example, 2, 5 - 7:0:0 5/*\/* means the event is triggered at 2 AM, 5AM, 6 AM and 7 AM every Friday. The specification of days can be made by two fields: day of the month (DD) and day of the week (W). If both are specified, both take effect. For example, 1:0:0 1/15/* means the event is triggered at 1 AM every Monday, as well as on the fifteenth of each month. To specify days by only one field, set the other field to *. This class is immutable, thread-safe, and serializable.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`IMMEDIATE` TimePattern string representing a pattern that always matches
`static TimePattern`	`IMMEDIATE_TIMEPATTERN` TimePattern that matches every instant in time
`static String`	`NEVER` TimePattern string representing a pattern that will never be matched.
`static TimePattern`	`NEVER_TIMEPATTERN` TimePattern that never matches any instant in time
`static String`	`sImmediate` Deprecated. use IMMEDIATE
`static String`	`sNever` Deprecated. use NEVER

Constructor Summary

Constructors
Constructor and Description

TimePattern(String pattern)
Deprecated.
use valueOf(String) instead

Constructors
Constructor and Description
`TimePattern(String pattern)` Deprecated. use valueOf(String) instead

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static TimePattern`	`getTimePattern(String tp)` Deprecated. (use valueOf(String) instead)
`boolean`	`matches(Calendar time)` Determines if this TimePattern has had a match between the specified time, and right now.
`boolean`	`never()` Return whether this timepattern is designed to never match
`Calendar`	`nextMatch(Calendar rangeStart, Calendar rangeEnd)` Get the next match for this TimePattern between the two dates passed in
`Date`	`nextMatch(Date rangeStart, Date rangeEnd)` Get the next match for this TimePattern between the two dates passed in
`boolean`	`now()` Return whether or not this TimePattern matches every instant in time.
`String`	`toString()` Return the string representation of a time pattern
`static TimePattern`	`valueOf(String pattern)` Return an instance of a TimePattern object given the input string specified.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NEVER
```
public static final String NEVER
```
    TimePattern string representing a pattern that will never be matched.
    
    See Also:
    
    Constant Field Values
  - IMMEDIATE
```
public static final String IMMEDIATE
```
    TimePattern string representing a pattern that always matches
    
    See Also:
    
    Constant Field Values
  - sNever
```
public static final String sNever
```
    Deprecated. use NEVER
    
    See Also:
    
    Constant Field Values
  - sImmediate
```
public static final String sImmediate
```
    Deprecated. use IMMEDIATE
    
    See Also:
    
    Constant Field Values
  - NEVER_TIMEPATTERN
```
public static final TimePattern NEVER_TIMEPATTERN
```
    TimePattern that never matches any instant in time
  - IMMEDIATE_TIMEPATTERN
```
public static final TimePattern IMMEDIATE_TIMEPATTERN
```
    TimePattern that matches every instant in time
- Constructor Detail
  - TimePattern
```
public TimePattern(String pattern)
```
    Deprecated. use valueOf(String) instead
    
    Construct a TimePattern from a well formed string. No error checking done
    
    Parameters:
    
    pattern - time pattern string
    
    Throws:
    
    IllegalArgumentException - if the TimePattern is invalid
- Method Detail
  - valueOf
```
public static final TimePattern valueOf(String pattern)
```
    Return an instance of a TimePattern object given the input string specified.
    
    Parameters:
    
    pattern - TimePattern string
    
    Returns:
    
    TimePattern object
    
    Throws:
    
    IllegalArgumentException - if the pattern specified is now well-formed.
    
    Since:
    
    6.0
  - getTimePattern
```
public static final TimePattern getTimePattern(String tp)
```
    Deprecated. (use valueOf(String) instead)
    
    Create a timepattern that (1) never expires (2) expires now or (3) a regular old time pattern, using the input string
    
    Parameters:
    
    tp - time pattern string
    
    Returns:
    
    TimePattern, MAY BE NULL
    
    Throws:
    
    IllegalArgumentException - on invalid data
  - toString
```
public String toString()
```
    Return the string representation of a time pattern
    
    Overrides:
    
    toString in class Object
  - never
```
public boolean never()
```
    Return whether this timepattern is designed to never match
    
    Returns:
    
    true if no match will ever be found, false if it is possible to match this TimePattern to an instant in time
  - now
```
public boolean now()
```
    Return whether or not this TimePattern matches every instant in time.
    
    Returns:
    
    true if the TimePattern matches every instant in time, false if it matches only specific instants in time.
  - matches
```
public boolean matches(Calendar time)
```
    Determines if this TimePattern has had a match between the specified time, and right now.
    
    Parameters:
    
    time - The last time this TimePattern had a match.
    
    Returns:
    
    true if this TimePattern has had a match between time and now, false otherwise.
  - nextMatch
```
public Date nextMatch(Date rangeStart,
                      Date rangeEnd)
```
    Get the next match for this TimePattern between the two dates passed in
    
    Parameters:
    
    rangeStart - Find the next match after this date
    
    rangeEnd - Find the next match before this match
    
    Returns:
    
    Calendar set to the next matching time in the range specified, or null if no matches exist in the range specified.
    
    Since:
    
    7.0
  - nextMatch
```
public Calendar nextMatch(Calendar rangeStart,
                          Calendar rangeEnd)
```
    Get the next match for this TimePattern between the two dates passed in
    
    Parameters:
    
    rangeStart - Find the next match after this date
    
    rangeEnd - Find the next match before this match
    
    Returns:
    
    Calendar set to the next matching time in the range specified, or null if no matches exist in the range specified.
    
    Since:
    
    6.0

Class TimePattern

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NEVER

IMMEDIATE

sNever

sImmediate

NEVER_TIMEPATTERN

IMMEDIATE_TIMEPATTERN

Constructor Detail

TimePattern

Method Detail

valueOf

getTimePattern

toString

never

now

matches

nextMatch

nextMatch