Java Doc for BaseCalendar.java in » Project-Management » quartz » org » quartz » impl » calendar » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Project Management » quartz » org.quartz.impl.calendar

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.quartz.impl.calendar .BaseCalendar

All known Subclasses:   org.quartz.impl.calendar .CronCalendar,  org.quartz.impl.calendar .DailyCalendar,  org.quartz.impl.calendar .HolidayCalendar,  org.quartz.impl.calendar .WeeklyCalendar,  org.quartz.impl.calendar .AnnualCalendar,  org.quartz.impl.calendar .MonthlyCalendar,
BaseCalendar
public class BaseCalendar implements Calendar,Serializable(Code)

This implementation of the Calendar may be used (you don't have to) as a base class for more sophisticated one's. It merely implements the base functionality required by each Calendar.

Regarded as base functionality is the treatment of base calendars. Base calendar allow you to chain (stack) as much calendars as you may need. For example to exclude weekends you may use WeeklyCalendar. In order to exclude holidays as well you may define a WeeklyCalendar instance to be the base calendar for HolidayCalendar instance.

See Also:   org.quartz.Calendar
author:
   Juergen Donnerstag
author:
   James House

Field Summary
final static long serialVersionUID


Constructor Summary
public BaseCalendar()

public BaseCalendar(Calendar baseCalendar)

public BaseCalendar(TimeZone timeZone)

public BaseCalendar(Calendar baseCalendar, TimeZone timeZone)


Method Summary
public static Date buildHoliday(Date excludedDate)
     Utility method.
public static long buildHoliday(long timeStamp)
     Utility method.
protected java.util.Calendar createJavaCalendar(long timeStamp)
     Build a java.util.Calendar for the given timeStamp.
protected java.util.Calendar createJavaCalendar()
     Build a java.util.Calendar with the current time.
public Calendar getBaseCalendar()

Get the base calendar.
public String getDescription()

Return the description given to the Calendar instance by its creator (if any).
protected java.util.Calendar getEndOfDayJavaCalendar(long timeInMillis)
     Returns the end of the given day java.util.Calendar.
public static java.util.Calendar getJavaCalendar(long timeStamp)
     Utility method.
public long getNextIncludedTime(long timeStamp)

Determine the next time (in milliseconds) that is 'included' by the Calendar after the given time.
protected java.util.Calendar getStartOfDayJavaCalendar(long timeInMillis)
     Returns the start of the given day as a java.util.Calendar.
public TimeZone getTimeZone()
     Returns the time zone for which this Calendar will be resolved.
public boolean isTimeIncluded(long timeStamp)

Check if date/time represented by timeStamp is included.
public void setBaseCalendar(Calendar baseCalendar)

public void setDescription(String description)

Set a description for the Calendar instance - may be useful for remembering/displaying the purpose of the calendar, though the description has no meaning to Quartz.
public void setTimeZone(TimeZone timeZone)
     Sets the time zone for which this Calendar will be resolved.

Field Detail
serialVersionUID
final static long serialVersionUID(Code)

Constructor Detail
BaseCalendar
public BaseCalendar()(Code)

BaseCalendar
public BaseCalendar(Calendar baseCalendar)(Code)

BaseCalendar
public BaseCalendar(TimeZone timeZone)(Code)

Parameters:
  timeZone - The time zone to use for this Calendar, null if TimeZone.getDefault should be used

BaseCalendar
public BaseCalendar(Calendar baseCalendar, TimeZone timeZone)(Code)

Parameters:
  timeZone - The time zone to use for this Calendar, null if TimeZone.getDefault should be used

Method Detail
buildHoliday
public static Date buildHoliday(Date excludedDate)(Code)
Utility method. Return the date of excludeDate. The time fraction will be reset to 00.00:00.

buildHoliday
public static long buildHoliday(long timeStamp)(Code)
Utility method. Return just the date of timeStamp. The time fraction will be reset to 00.00:00.

createJavaCalendar
protected java.util.Calendar createJavaCalendar(long timeStamp)(Code)
Build a java.util.Calendar for the given timeStamp. The new Calendar will use the BaseCalendar time zone if it is not null.

createJavaCalendar
protected java.util.Calendar createJavaCalendar()(Code)
Build a java.util.Calendar with the current time. The new Calendar will use the BaseCalendar time zone if it is not null.

getBaseCalendar
public Calendar getBaseCalendar()(Code)

Get the base calendar. Will be null, if not set.

getDescription
public String getDescription()(Code)

Return the description given to the Calendar instance by its creator (if any).
null if no description was set.

getEndOfDayJavaCalendar
protected java.util.Calendar getEndOfDayJavaCalendar(long timeInMillis)(Code)
Returns the end of the given day java.util.Calendar. This calculation will take the BaseCalendar time zone into account if it is not null.
Parameters:
  timeInMillis - a time containing the desired date for the end-of-day time. A java.util.Calendar set to the end of the given day.

getJavaCalendar
public static java.util.Calendar getJavaCalendar(long timeStamp)(Code)
Utility method. Return a java.util.Calendar for timeStamp.

getNextIncludedTime
public long getNextIncludedTime(long timeStamp)(Code)

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.

See Also:   org.quartz.Calendar.getNextIncludedTime(long)

getStartOfDayJavaCalendar
protected java.util.Calendar getStartOfDayJavaCalendar(long timeInMillis)(Code)
Returns the start of the given day as a java.util.Calendar. This calculation will take the BaseCalendar time zone into account if it is not null.
Parameters:
  timeInMillis - A time containing the desired date for the start-of-day time A java.util.Calendar set to the start of the given day.

getTimeZone
public TimeZone getTimeZone()(Code)
Returns the time zone for which this Calendar will be resolved. This Calendar's timezone, null if Calendar should use the TimeZone.getDefault

isTimeIncluded
public boolean isTimeIncluded(long timeStamp)(Code)

Check if date/time represented by timeStamp is included. If included return true. The implementation of BaseCalendar simply calls the base calendars isTimeIncluded() method if base calendar is set.

See Also:   org.quartz.Calendar.isTimeIncluded(long)

setBaseCalendar
public void setBaseCalendar(Calendar baseCalendar)(Code)

Set a new base calendar or remove the existing one

setDescription
public void setDescription(String description)(Code)

Set a description for the Calendar instance - may be useful for remembering/displaying the purpose of the calendar, though the description has no meaning to Quartz.

setTimeZone
public void setTimeZone(TimeZone timeZone)(Code)
Sets the time zone for which this Calendar will be resolved.
Parameters:
  timeZone - The time zone to use for this Calendar, null if TimeZone.getDefault should be used

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.