C# Class Quartz.CronExpression

Inheritance: ICloneable, IDeserializationCallback

Mostra file Open project: quartznet/quartznet Class Usage Examples

Public Properties

Property	Type	Description
MaxYear	int

Private Properties

Property	Type	Description
CheckIncrementRange	void
CronExpression	System

Public Methods

Method	Description
Clone ( ) : object	Creates a new object that is a copy of the current instance.
CronExpression ( string cronExpression ) : System	Constructs a new CronExpressionString based on the specified parameter.
Equals ( CronExpression other ) : bool	Determines whether the specified CronExpression is equal to the current CronExpression.
Equals ( object obj ) : bool	Determines whether the specified T:System.Object is equal to the current T:System.Object.
GetExpressionSummary ( ) : string	Gets the expression summary.
GetFinalFireTime ( ) : DateTimeOffset?	NOT YET IMPLEMENTED: Returns the final time that the CronExpression will match.
GetHashCode ( ) : int	Serves as a hash function for a particular type.
GetNextInvalidTimeAfter ( DateTimeOffset date ) : DateTimeOffset?	Returns the next date/time after the given date/time which does not satisfy the expression.
GetNextValidTimeAfter ( DateTimeOffset date ) : DateTimeOffset?	Returns the next date/time after the given date/time which satisfies the cron expression.
GetTimeAfter ( DateTimeOffset afterTimeUtc ) : DateTimeOffset?	Gets the next fire time after the given time.
GetTimeBefore ( DateTimeOffset endTime ) : DateTimeOffset?	Gets the time before.
IsSatisfiedBy ( DateTimeOffset dateUtc ) : bool	Indicates whether the given date satisfies the cron expression. Note that milliseconds are ignored, so two Dates falling on different milliseconds of the same second will always have the same result here.
IsValidExpression ( string cronExpression ) : bool	Indicates whether the specified cron expression can be parsed into a valid cron expression
OnDeserialization ( object sender ) : void
ToString ( ) : string	Returns the string representation of the CronExpression
ValidateExpression ( string cronExpression ) : void

Protected Methods

Method	Description
AddToSet ( int val, int end, int incr, int type ) : void	Adds to set.
BuildExpression ( string expression ) : void	Builds the expression.
CheckNext ( int pos, string s, int val, int type ) : int	Checks the next value.
CreateDateTimeWithoutMillis ( DateTimeOffset time ) : DateTimeOffset	Creates the date time without milliseconds.
FindNextWhiteSpace ( int i, string s ) : int	Finds the next white space.
GetDayOfWeekNumber ( string s ) : int	Gets the day of week number.
GetExpressionSetSummary ( ICollection data ) : string	Gets the expression set summary.
GetLastDayOfMonth ( int monthNum, int year ) : int	Gets the last day of month.
GetMonthNumber ( string s ) : int	Gets the month number.
GetNumericValue ( string s, int i ) : int	Gets the numeric value from string.
GetSet ( int type ) : ISet	Gets the set of given type.
GetTime ( int sc, int mn, int hr, int dayofmn, int mon ) : DateTimeOffset?	Gets the time from given time parts.
GetValue ( int v, string s, int i ) : ValueSet	Gets the value.
IsLeapYear ( int year ) : bool	Determines whether given year is a leap year.
SetCalendarHour ( DateTimeOffset date, int hour ) : DateTimeOffset	Advance the calendar to the particular hour paying particular attention to daylight saving problems.
SkipWhiteSpace ( int i, string s ) : int	Skips the white space.
StoreExpressionVals ( int pos, string s, int type ) : int	Stores the expression values.

Private Methods

Method	Description
CheckIncrementRange ( int incr, int type ) : void
CronExpression ( ) : System

Method Details

AddToSet() protected method

Adds to set.

protected AddToSet ( int val, int end, int incr, int type ) : void
val	int	The val.
end	int	The end.
incr	int	The incr.
type	int	The type.
return	void

BuildExpression() protected method

Builds the expression.

protected BuildExpression ( string expression ) : void
expression	string	The expression.
return	void

CheckNext() protected method

Checks the next value.

protected CheckNext ( int pos, string s, int val, int type ) : int
pos	int	The position.
s	string	The string to check.
val	int	The value.
type	int	The type to search.
return	int

Clone() public method

Creates a new object that is a copy of the current instance.

public Clone ( ) : object
return	object

CreateDateTimeWithoutMillis() protected static method

Creates the date time without milliseconds.

protected static CreateDateTimeWithoutMillis ( DateTimeOffset time ) : DateTimeOffset
time	DateTimeOffset	The time.
return	DateTimeOffset

CronExpression() public method

Constructs a new CronExpressionString based on the specified parameter.

public CronExpression ( string cronExpression ) : System
cronExpression	string	/// String representation of the cron expression the new object should represent ///
return	System

Equals() public method

Determines whether the specified CronExpression is equal to the current CronExpression.

public Equals ( CronExpression other ) : bool
other	CronExpression	The to compare with the current .
return	bool

Equals() public method

Determines whether the specified T:System.Object is equal to the current T:System.Object.

public Equals ( object obj ) : bool
obj	object	The to compare with the current .
return	bool

FindNextWhiteSpace() protected method

Finds the next white space.

protected FindNextWhiteSpace ( int i, string s ) : int
i	int	The i.
s	string	The s.
return	int

GetDayOfWeekNumber() protected method

Gets the day of week number.

protected GetDayOfWeekNumber ( string s ) : int
s	string	The s.
return	int

GetExpressionSetSummary() protected method

Gets the expression set summary.

protected GetExpressionSetSummary ( ICollection data ) : string
data	ICollection	The data.
return	string

GetExpressionSummary() public method

Gets the expression summary.

public GetExpressionSummary ( ) : string
return	string

GetFinalFireTime() public method

NOT YET IMPLEMENTED: Returns the final time that the CronExpression will match.

public GetFinalFireTime ( ) : DateTimeOffset?
return	DateTimeOffset?

GetHashCode() public method

Serves as a hash function for a particular type.

public GetHashCode ( ) : int
return	int

GetLastDayOfMonth() protected method

Gets the last day of month.

protected GetLastDayOfMonth ( int monthNum, int year ) : int
monthNum	int	The month num.
year	int	The year.
return	int

GetMonthNumber() protected method

Gets the month number.

protected GetMonthNumber ( string s ) : int
s	string	The string to map with.
return	int

GetNextInvalidTimeAfter() public method

Returns the next date/time after the given date/time which does not satisfy the expression.

public GetNextInvalidTimeAfter ( DateTimeOffset date ) : DateTimeOffset?
date	DateTimeOffset	the date/time at which to begin the search for the next invalid date/time
return	DateTimeOffset?

GetNextValidTimeAfter() public method

Returns the next date/time after the given date/time which satisfies the cron expression.

public GetNextValidTimeAfter ( DateTimeOffset date ) : DateTimeOffset?
date	DateTimeOffset	the date/time at which to begin the search for the next valid date/time
return	DateTimeOffset?

GetNumericValue() protected method

Gets the numeric value from string.

protected GetNumericValue ( string s, int i ) : int
s	string	The string to parse from.
i	int	The i.
return	int

GetSet() protected method

Gets the set of given type.

protected GetSet ( int type ) : ISet
type	int	The type of set to get.
return	ISet

GetTime() protected method

Gets the time from given time parts.

protected GetTime ( int sc, int mn, int hr, int dayofmn, int mon ) : DateTimeOffset?
sc	int	The seconds.
mn	int	The minutes.
hr	int	The hours.
dayofmn	int	The day of month.
mon	int	The month.
return	DateTimeOffset?

GetTimeAfter() public method

Gets the next fire time after the given time.

public GetTimeAfter ( DateTimeOffset afterTimeUtc ) : DateTimeOffset?
afterTimeUtc	DateTimeOffset	The UTC time to start searching from.
return	DateTimeOffset?

GetTimeBefore() public method

Gets the time before.

public GetTimeBefore ( DateTimeOffset endTime ) : DateTimeOffset?
endTime	DateTimeOffset	The end time.
return	DateTimeOffset?

GetValue() protected method

Gets the value.

protected GetValue ( int v, string s, int i ) : ValueSet
v	int	The v.
s	string	The s.
i	int	The i.
return	ValueSet

IsLeapYear() protected method

Determines whether given year is a leap year.

protected IsLeapYear ( int year ) : bool
year	int	The year.
return	bool

IsSatisfiedBy() public method

Indicates whether the given date satisfies the cron expression.

Note that milliseconds are ignored, so two Dates falling on different milliseconds of the same second will always have the same result here.

public IsSatisfiedBy ( DateTimeOffset dateUtc ) : bool
dateUtc	DateTimeOffset	The date to evaluate.
return	bool

IsValidExpression() public static method

Indicates whether the specified cron expression can be parsed into a valid cron expression

public static IsValidExpression ( string cronExpression ) : bool
cronExpression	string	the expression to evaluate
return	bool

OnDeserialization() public method

public OnDeserialization ( object sender ) : void
sender	object
return	void

SetCalendarHour() protected static method

Advance the calendar to the particular hour paying particular attention to daylight saving problems.

protected static SetCalendarHour ( DateTimeOffset date, int hour ) : DateTimeOffset
date	DateTimeOffset	The date.
hour	int	The hour.
return	DateTimeOffset

SkipWhiteSpace() protected method

Skips the white space.

protected SkipWhiteSpace ( int i, string s ) : int
i	int	The i.
s	string	The s.
return	int

StoreExpressionVals() protected method

Stores the expression values.

protected StoreExpressionVals ( int pos, string s, int type ) : int
pos	int	The position.
s	string	The string to traverse.
type	int	The type of value.
return	int

ToString() public method

Returns the string representation of the CronExpression

public ToString ( ) : string
return	string

ValidateExpression() public static method

public static ValidateExpression ( string cronExpression ) : void
cronExpression	string
return	void

Property Details

MaxYear public_oe static_oe property

public static int MaxYear
return	int