jobqueue.html

turbine教程

<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="JobQueue()"><!-- --></A><H3>
JobQueue</H3>
<PRE>
public <B>JobQueue</B>()
         throws java.lang.Exception</PRE>
<DL>
<DD>Creates a new instance.<DD><DL>
<DT><B>Throws:</B><DD><CODE>java.lang.Exception</CODE> - A generic exception.</DL>
</DD>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="getNext()"><!-- --></A><H3>
getNext</H3>
<PRE>
public <A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html">JobEntry</A> <B>getNext</B>()</PRE>
<DL>
<DD>Return the next job off the top of the queue, or <code>null</code> if
 there are no jobs in the queue.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The next job in the queue.</DL>
</DD>
</DL>
<HR>

<A NAME="getJob(org.apache.turbine.services.schedule.JobEntry)"><!-- --></A><H3>
getJob</H3>
<PRE>
public <A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html">JobEntry</A> <B>getJob</B>(<A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html">JobEntry</A>&nbsp;je)</PRE>
<DL>
<DD>Return a specific job.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>je</CODE> - The JobEntry we are looking for.<DT><B>Returns:</B><DD>A JobEntry.</DL>
</DD>
</DL>
<HR>

<A NAME="list()"><!-- --></A><H3>
list</H3>
<PRE>
public java.util.Vector <B>list</B>()</PRE>
<DL>
<DD>List jobs in the queue.  This is used by the scheduler UI.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A Vector of <code>JobEntry</code> objects.</DL>
</DD>
</DL>
<HR>

<A NAME="add(org.apache.turbine.services.schedule.JobEntry)"><!-- --></A><H3>
add</H3>
<PRE>
public void <B>add</B>(<A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html">JobEntry</A>&nbsp;je)</PRE>
<DL>
<DD>Add a job to the queue.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>je</CODE> - A JobEntry job.</DL>
</DD>
</DL>
<HR>

<A NAME="batchLoad(java.util.List)"><!-- --></A><H3>
batchLoad</H3>
<PRE>
public void <B>batchLoad</B>(java.util.List&nbsp;jobEntries)</PRE>
<DL>
<DD>Batch load jobs.  Retains any already enqueued jobs.  Called on
 <code>SchedulerService</code> start-up.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jobEntries</CODE> - A list of the <code>JobEntry</code> objects to load.</DL>
</DD>
</DL>
<HR>

<A NAME="remove(org.apache.turbine.services.schedule.JobEntry)"><!-- --></A><H3>
remove</H3>
<PRE>
public void <B>remove</B>(<A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html">JobEntry</A>&nbsp;je)</PRE>
<DL>
<DD>Remove a job from the queue.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>je</CODE> - A JobEntry with the job to remove.</DL>
</DD>
</DL>
<HR>

<A NAME="modify(org.apache.turbine.services.schedule.JobEntry)"><!-- --></A><H3>
modify</H3>
<PRE>
public void <B>modify</B>(<A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html">JobEntry</A>&nbsp;je)</PRE>
<DL>
<DD>Modify a job on the queue.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>je</CODE> - A JobEntry with the job to modify</DL>
</DD>
</DL>
<HR>

<A NAME="updateQueue(org.apache.turbine.services.schedule.JobEntry)"><!-- --></A><H3>
updateQueue</H3>
<PRE>
public void <B>updateQueue</B>(<A HREF="../../../../../org/apache/turbine/services/schedule/JobEntry.html">JobEntry</A>&nbsp;je)
                 throws java.lang.Exception</PRE>
<DL>
<DD>Update the job for its next run time.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>je</CODE> - A JobEntry to be updated.<DT><B>Throws:</B><DD><CODE>Exception,</CODE> - a generic exception.</DL>
</DD>
</DL>
<HR>

<A NAME="compare(java.lang.Object, java.lang.Object)"><!-- --></A><H3>
compare</H3>
<PRE>
public int <B>compare</B>(java.lang.Object&nbsp;je1,
                   java.lang.Object&nbsp;je2)</PRE>
<DL>
<DD>Compare to another <code>JobEntry</code>.  Used by the
 <code>QuickSort</code> class to determine sort order.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/util/Comparable.html#compare(java.lang.Object, java.lang.Object)">compare</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/util/Comparable.html">Comparable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>je1</CODE> - The first <code>JobEntry</code> object.<DD><CODE>je2</CODE> - The second <code>JobEntry</code> object.<DT><B>Returns:</B><DD>An <code>int</code> indicating the result of the comparison.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/JobQueue.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/turbine/services/schedule/JobEntryPeer.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/turbine/services/schedule/TurbineNonPersistentSchedulerService.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="JobQueue.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
Copyright &copy; 2000-2002 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>