C# Class Quartz.TextToSchedule.Calendars.LocalDailyCalendar

Inheritance: Quartz.Impl.Calendar.BaseCalendar
显示文件 Open project: amazing-andrew/Quartz.TextToSchedule Class Usage Examples

Public Methods

Method Description
Clone ( ) : object
Equals ( LocalDailyCalendar obj ) : bool
Equals ( object obj ) : bool
GetHashCode ( ) : int
GetNextIncludedTimeUtc ( DateTimeOffset timeUtc ) : DateTimeOffset

Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time. Return the original value if timeStamp is included. Return 0 if all days are excluded.
GetTimeRangeEndingTimeUtc ( DateTimeOffset timeUtc ) : DateTimeOffset

Returns the end time of the time range of the day specified in

GetTimeRangeStartingTimeUtc ( DateTimeOffset timeUtc ) : DateTimeOffset

Returns the start time of the time range of the day specified in .
IsTimeIncluded ( DateTimeOffset timeUtc ) : bool

Determine whether the given time is 'included' by the Calendar.
LocalDailyCalendar ( System.DateTime rangeStartingCalendarUtc, System.DateTime rangeEndingCalendarUtc ) : Quartz.TextToSchedule.Util

Create a LocalDailyCalendar with a time range defined by the specified DateTimes and no baseCalendar. The Calendars are subject to the following considerations:

  • Only the time-of-day fields of the specified Calendars will be used (the date fields will be ignored)
  • The starting time must be before the ending time of the defined time range. Note this means that a time range may not cross daily boundaries (10PM - 2AM). (because only time fields are are used, it is possible for two Calendars to represent a valid time range and rangeStartingCalendar.after(rangeEndingCalendar) == true)

LocalDailyCalendar ( ICalendar baseCalendar, System.DateTime rangeStartingCalendarUtc, System.DateTime rangeEndingCalendarUtc ) : Quartz.TextToSchedule.Util

Create a LocalDailyCalendar with a time range defined by the specified DateTimes and the specified . The Calendars are subject to the following considerations:

  • Only the time-of-day fields of the specified Calendars will be used (the date fields will be ignored)
  • The starting time must be before the ending time of the defined time range. Note this means that a time range may not cross daily boundaries (10PM - 2AM). (because only time fields are are used, it is possible for two Calendars to represent a valid time range and rangeStartingCalendarUtc > rangeEndingCalendarUtc == true)

LocalDailyCalendar ( ICalendar baseCalendar, int rangeStartingHourOfDay, int rangeStartingMinute, int rangeStartingSecond, int rangeStartingMillis, int rangeEndingHourOfDay, int rangeEndingMinute, int rangeEndingSecond, int rangeEndingMillis ) : Quartz.TextToSchedule.Util

Create a LocalDailyCalendar with a time range defined by the specified values and the specified . Values are subject to the following validations:

  • Hours must be in the range 0-23 and are expressed using military (24-hour) time.
  • Minutes must be in the range 0-59
  • Seconds must be in the range 0-59
  • Milliseconds must be in the range 0-999
  • The time range starting time must be before the time range ending time. Note this means that a time range may not cross daily boundaries (10PM - 2AM)

LocalDailyCalendar ( ICalendar baseCalendar, long rangeStartingTimeInMillis, long rangeEndingTimeInMillis ) : Quartz.TextToSchedule.Util

Create a LocalDailyCalendar with a time range defined by the specified values and the specified . The values are subject to the following considerations:

  • Only the time-of-day portion of the specified values will be used
  • The starting time must be before the ending time of the defined time range. Note this means that a time range may not cross daily boundaries (10PM - 2AM). (because only time value are are used, it is possible for the two values to represent a valid time range and rangeStartingTime > rangeEndingTime)

LocalDailyCalendar ( ICalendar baseCalendar, string rangeStartingTime, string rangeEndingTime ) : Quartz.TextToSchedule.Util

Create a LocalDailyCalendar with a time range defined by the specified strings and the specified baseCalendar. and must be in the format "HH:MM[:SS[:mmm]]" where:

  • HH is the hour of the specified time. The hour should be specified using military (24-hour) time and must be in the range 0 to 23.
  • MM is the minute of the specified time and must be in the range 0 to 59.
  • SS is the second of the specified time and must be in the range 0 to 59.
  • mmm is the millisecond of the specified time and must be in the range 0 to 999.
  • items enclosed in brackets ('[', ']') are optional.
  • The time range starting time must be before the time range ending time. Note this means that a time range may not cross daily boundaries (10PM - 2AM)

LocalDailyCalendar ( int rangeStartingHourOfDay, int rangeStartingMinute, int rangeStartingSecond, int rangeStartingMillis, int rangeEndingHourOfDay, int rangeEndingMinute, int rangeEndingSecond, int rangeEndingMillis ) : Quartz.TextToSchedule.Util

Create a LocalDailyCalendar with a time range defined by the specified values and no baseCalendar. Values are subject to the following validations:

  • Hours must be in the range 0-23 and are expressed using military (24-hour) time.
  • Minutes must be in the range 0-59
  • Seconds must be in the range 0-59
  • Milliseconds must be in the range 0-999
  • The time range starting time must be before the time range ending time. Note this means that a time range may not cross daily boundaries (10PM - 2AM)

LocalDailyCalendar ( long rangeStartingTimeInMillis, long rangeEndingTimeInMillis ) : Quartz.TextToSchedule.Util

Create a LocalDailyCalendar with a time range defined by the specified values and no baseCalendar. The values are subject to the following considerations:

  • Only the time-of-day portion of the specified values will be used
  • The starting time must be before the ending time of the defined time range. Note this means that a time range may not cross daily boundaries (10PM - 2AM). (because only time value are are used, it is possible for the two values to represent a valid time range and rangeStartingTime > rangeEndingTime)

LocalDailyCalendar ( string rangeStartingTime, string rangeEndingTime ) : Quartz.TextToSchedule.Util

Create a LocalDailyCalendar with a time range defined by the specified strings and no baseCalendar. and must be in the format "HH:MM[:SS[:mmm]]" where:

  • HH is the hour of the specified time. The hour should be specified using military (24-hour) time and must be in the range 0 to 23.
  • MM is the minute of the specified time and must be in the range 0 to 59.
  • SS is the second of the specified time and must be in the range 0 to 59.
  • mmm is the millisecond of the specified time and must be in the range 0 to 999.
  • items enclosed in brackets ('[', ']') are optional.
  • The time range starting time must be before the time range ending time. Note this means that a time range may not cross daily boundaries (10PM - 2AM)

SetTimeRange ( System.DateTime rangeStartingCalendarUtc, System.DateTime rangeEndingCalendarUtc ) : void

Sets the time range for the LocalDailyCalendar to the times represented in the specified DateTimes.
SetTimeRange ( int rangeStartingHourOfDay, int rangeStartingMinute, int rangeStartingSecond, int rangeStartingMillis, int rangeEndingHourOfDay, int rangeEndingMinute, int rangeEndingSecond, int rangeEndingMillis ) : void

Sets the time range for the LocalDailyCalendar to the times represented in the specified values.
SetTimeRange ( long rangeStartingTime, long rangeEndingTime ) : void

Sets the time range for the LocalDailyCalendar to the times represented in the specified values.
SetTimeRange ( string rangeStartingTimeString, string rangeEndingTimeString ) : void

Sets the time range for the LocalDailyCalendar to the times represented in the specified Strings.
ToString ( ) : string

Returns a that represents the current .

Protected Methods

Method Description
LocalDailyCalendar ( SerializationInfo info, StreamingContext context ) : Quartz.TextToSchedule.Util

Serialization constructor.

Private Methods

Method Description
GetEndOfDay ( DateTimeOffset time ) : DateTimeOffset

Gets the end of day, practically sets time parts to maximum allowed values.
GetObjectData ( SerializationInfo info, StreamingContext context ) : void
GetStartOfDay ( DateTimeOffset time ) : DateTimeOffset

Gets the start of day, practically zeroes time part.
Validate ( int hourOfDay, int minute, int second, int millis ) : void

Checks the specified values for validity as a set of time values.

Method Details

Clone() public method

public Clone ( ) : object
return object

Equals() public method

public Equals ( LocalDailyCalendar obj ) : bool
obj LocalDailyCalendar
return bool

Equals() public method

public Equals ( object obj ) : bool
obj object
return bool

GetHashCode() public method

public GetHashCode ( ) : int
return int

GetNextIncludedTimeUtc() public method

Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time. Return the original value if timeStamp is included. Return 0 if all days are excluded.
public GetNextIncludedTimeUtc ( DateTimeOffset timeUtc ) : DateTimeOffset
timeUtc DateTimeOffset
return DateTimeOffset

GetTimeRangeEndingTimeUtc() public method

Returns the end time of the time range of the day specified in
public GetTimeRangeEndingTimeUtc ( DateTimeOffset timeUtc ) : DateTimeOffset
timeUtc DateTimeOffset
return DateTimeOffset

GetTimeRangeStartingTimeUtc() public method

Returns the start time of the time range of the day specified in .
public GetTimeRangeStartingTimeUtc ( DateTimeOffset timeUtc ) : DateTimeOffset
timeUtc DateTimeOffset
return DateTimeOffset

IsTimeIncluded() public method

Determine whether the given time is 'included' by the Calendar.
public IsTimeIncluded ( DateTimeOffset timeUtc ) : bool
timeUtc DateTimeOffset
return bool

LocalDailyCalendar() public method

Create a LocalDailyCalendar with a time range defined by the specified DateTimes and no baseCalendar. The Calendars are subject to the following considerations:
  • Only the time-of-day fields of the specified Calendars will be used (the date fields will be ignored)
  • The starting time must be before the ending time of the defined time range. Note this means that a time range may not cross daily boundaries (10PM - 2AM). (because only time fields are are used, it is possible for two Calendars to represent a valid time range and rangeStartingCalendar.after(rangeEndingCalendar) == true)
public LocalDailyCalendar ( System.DateTime rangeStartingCalendarUtc, System.DateTime rangeEndingCalendarUtc ) : Quartz.TextToSchedule.Util
rangeStartingCalendarUtc System.DateTime The range starting calendar.
rangeEndingCalendarUtc System.DateTime The range ending calendar.
return Quartz.TextToSchedule.Util

LocalDailyCalendar() public method

Create a LocalDailyCalendar with a time range defined by the specified DateTimes and the specified . The Calendars are subject to the following considerations:
  • Only the time-of-day fields of the specified Calendars will be used (the date fields will be ignored)
  • The starting time must be before the ending time of the defined time range. Note this means that a time range may not cross daily boundaries (10PM - 2AM). (because only time fields are are used, it is possible for two Calendars to represent a valid time range and rangeStartingCalendarUtc > rangeEndingCalendarUtc == true)
public LocalDailyCalendar ( ICalendar baseCalendar, System.DateTime rangeStartingCalendarUtc, System.DateTime rangeEndingCalendarUtc ) : Quartz.TextToSchedule.Util
baseCalendar ICalendar
rangeStartingCalendarUtc System.DateTime The range starting calendar.
rangeEndingCalendarUtc System.DateTime The range ending calendar.
return Quartz.TextToSchedule.Util

LocalDailyCalendar() public method

Create a LocalDailyCalendar with a time range defined by the specified values and the specified . Values are subject to the following validations:
  • Hours must be in the range 0-23 and are expressed using military (24-hour) time.
  • Minutes must be in the range 0-59
  • Seconds must be in the range 0-59
  • Milliseconds must be in the range 0-999
  • The time range starting time must be before the time range ending time. Note this means that a time range may not cross daily boundaries (10PM - 2AM)
public LocalDailyCalendar ( ICalendar baseCalendar, int rangeStartingHourOfDay, int rangeStartingMinute, int rangeStartingSecond, int rangeStartingMillis, int rangeEndingHourOfDay, int rangeEndingMinute, int rangeEndingSecond, int rangeEndingMillis ) : Quartz.TextToSchedule.Util
baseCalendar ICalendar
rangeStartingHourOfDay int The range starting hour of day.
rangeStartingMinute int The range starting minute.
rangeStartingSecond int The range starting second.
rangeStartingMillis int The range starting millis.
rangeEndingHourOfDay int The range ending hour of day.
rangeEndingMinute int The range ending minute.
rangeEndingSecond int The range ending second.
rangeEndingMillis int The range ending millis.
return Quartz.TextToSchedule.Util

LocalDailyCalendar() public method

Create a LocalDailyCalendar with a time range defined by the specified values and the specified . The values are subject to the following considerations:
  • Only the time-of-day portion of the specified values will be used
  • The starting time must be before the ending time of the defined time range. Note this means that a time range may not cross daily boundaries (10PM - 2AM). (because only time value are are used, it is possible for the two values to represent a valid time range and rangeStartingTime > rangeEndingTime)
public LocalDailyCalendar ( ICalendar baseCalendar, long rangeStartingTimeInMillis, long rangeEndingTimeInMillis ) : Quartz.TextToSchedule.Util
baseCalendar ICalendar
rangeStartingTimeInMillis long The range starting time in millis.
rangeEndingTimeInMillis long The range ending time in millis.
return Quartz.TextToSchedule.Util

LocalDailyCalendar() public method

Create a LocalDailyCalendar with a time range defined by the specified strings and the specified baseCalendar. and must be in the format "HH:MM[:SS[:mmm]]" where:
  • HH is the hour of the specified time. The hour should be specified using military (24-hour) time and must be in the range 0 to 23.
  • MM is the minute of the specified time and must be in the range 0 to 59.
  • SS is the second of the specified time and must be in the range 0 to 59.
  • mmm is the millisecond of the specified time and must be in the range 0 to 999.
  • items enclosed in brackets ('[', ']') are optional.
  • The time range starting time must be before the time range ending time. Note this means that a time range may not cross daily boundaries (10PM - 2AM)
public LocalDailyCalendar ( ICalendar baseCalendar, string rangeStartingTime, string rangeEndingTime ) : Quartz.TextToSchedule.Util
baseCalendar ICalendar The base calendar for this calendar instance see BaseCalendar for more /// information on base calendar functionality.
rangeStartingTime string
rangeEndingTime string
return Quartz.TextToSchedule.Util

LocalDailyCalendar() protected method

Serialization constructor.
protected LocalDailyCalendar ( SerializationInfo info, StreamingContext context ) : Quartz.TextToSchedule.Util
info System.Runtime.Serialization.SerializationInfo
context System.Runtime.Serialization.StreamingContext
return Quartz.TextToSchedule.Util

LocalDailyCalendar() public method

Create a LocalDailyCalendar with a time range defined by the specified values and no baseCalendar. Values are subject to the following validations:
  • Hours must be in the range 0-23 and are expressed using military (24-hour) time.
  • Minutes must be in the range 0-59
  • Seconds must be in the range 0-59
  • Milliseconds must be in the range 0-999
  • The time range starting time must be before the time range ending time. Note this means that a time range may not cross daily boundaries (10PM - 2AM)
public LocalDailyCalendar ( int rangeStartingHourOfDay, int rangeStartingMinute, int rangeStartingSecond, int rangeStartingMillis, int rangeEndingHourOfDay, int rangeEndingMinute, int rangeEndingSecond, int rangeEndingMillis ) : Quartz.TextToSchedule.Util
rangeStartingHourOfDay int The range starting hour of day.
rangeStartingMinute int The range starting minute.
rangeStartingSecond int The range starting second.
rangeStartingMillis int The range starting millis.
rangeEndingHourOfDay int The range ending hour of day.
rangeEndingMinute int The range ending minute.
rangeEndingSecond int The range ending second.
rangeEndingMillis int The range ending millis.
return Quartz.TextToSchedule.Util

LocalDailyCalendar() public method

Create a LocalDailyCalendar with a time range defined by the specified values and no baseCalendar. The values are subject to the following considerations:
  • Only the time-of-day portion of the specified values will be used
  • The starting time must be before the ending time of the defined time range. Note this means that a time range may not cross daily boundaries (10PM - 2AM). (because only time value are are used, it is possible for the two values to represent a valid time range and rangeStartingTime > rangeEndingTime)
public LocalDailyCalendar ( long rangeStartingTimeInMillis, long rangeEndingTimeInMillis ) : Quartz.TextToSchedule.Util
rangeStartingTimeInMillis long The range starting time in millis.
rangeEndingTimeInMillis long The range ending time in millis.
return Quartz.TextToSchedule.Util

LocalDailyCalendar() public method

Create a LocalDailyCalendar with a time range defined by the specified strings and no baseCalendar. and must be in the format "HH:MM[:SS[:mmm]]" where:
  • HH is the hour of the specified time. The hour should be specified using military (24-hour) time and must be in the range 0 to 23.
  • MM is the minute of the specified time and must be in the range 0 to 59.
  • SS is the second of the specified time and must be in the range 0 to 59.
  • mmm is the millisecond of the specified time and must be in the range 0 to 999.
  • items enclosed in brackets ('[', ']') are optional.
  • The time range starting time must be before the time range ending time. Note this means that a time range may not cross daily boundaries (10PM - 2AM)
public LocalDailyCalendar ( string rangeStartingTime, string rangeEndingTime ) : Quartz.TextToSchedule.Util
rangeStartingTime string
rangeEndingTime string
return Quartz.TextToSchedule.Util

SetTimeRange() public method

Sets the time range for the LocalDailyCalendar to the times represented in the specified DateTimes.
public SetTimeRange ( System.DateTime rangeStartingCalendarUtc, System.DateTime rangeEndingCalendarUtc ) : void
rangeStartingCalendarUtc System.DateTime The range starting calendar.
rangeEndingCalendarUtc System.DateTime The range ending calendar.
return void

SetTimeRange() public method

Sets the time range for the LocalDailyCalendar to the times represented in the specified values.
public SetTimeRange ( int rangeStartingHourOfDay, int rangeStartingMinute, int rangeStartingSecond, int rangeStartingMillis, int rangeEndingHourOfDay, int rangeEndingMinute, int rangeEndingSecond, int rangeEndingMillis ) : void
rangeStartingHourOfDay int The range starting hour of day.
rangeStartingMinute int The range starting minute.
rangeStartingSecond int The range starting second.
rangeStartingMillis int The range starting millis.
rangeEndingHourOfDay int The range ending hour of day.
rangeEndingMinute int The range ending minute.
rangeEndingSecond int The range ending second.
rangeEndingMillis int The range ending millis.
return void

SetTimeRange() public method

Sets the time range for the LocalDailyCalendar to the times represented in the specified values.
public SetTimeRange ( long rangeStartingTime, long rangeEndingTime ) : void
rangeStartingTime long The range starting time.
rangeEndingTime long The range ending time.
return void

SetTimeRange() public method

Sets the time range for the LocalDailyCalendar to the times represented in the specified Strings.
public SetTimeRange ( string rangeStartingTimeString, string rangeEndingTimeString ) : void
rangeStartingTimeString string The range starting time string.
rangeEndingTimeString string The range ending time string.
return void

ToString() public method

Returns a that represents the current .
public ToString ( ) : string
return string