KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > util > threadpool > TaskWrapper


1 /*
2   * JBoss, Home of Professional Open Source
3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
4   * by the @authors tag. See the copyright.txt in the distribution for a
5   * full listing of individual contributors.
6   *
7   * This is free software; you can redistribute it and/or modify it
8   * under the terms of the GNU Lesser General Public License as
9   * published by the Free Software Foundation; either version 2.1 of
10   * the License, or (at your option) any later version.
11   *
12   * This software is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15   * Lesser General Public License for more details.
16   *
17   * You should have received a copy of the GNU Lesser General Public
18   * License along with this software; if not, write to the Free
19   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21   */
22 package org.jboss.util.threadpool;
23
24 /**
25  * A task wrapper for a thread pool.
26  *
27  * @author <a HREF="mailto:adrian@jboss.org">Adrian Brock</a>
28  * @version $Revision: 1958 $
29  */
30 public interface TaskWrapper extends Runnable JavaDoc
31 {
32    // Constants -----------------------------------------------------
33
34    // Public --------------------------------------------------------
35
36    /**
37     * Get the type of wait
38     *
39     * @return the wait type
40     */
41    int getTaskWaitType();
42
43    /**
44     * The priority of the task
45     *
46     * @return the task priority
47     */
48    int getTaskPriority();
49
50    /**
51     * The time before the task must be accepted
52     *
53     * @return the start timeout
54     */
55    long getTaskStartTimeout();
56
57    /**
58     * The time before the task must be completed
59     *
60     * @return the completion timeout
61     */
62    long getTaskCompletionTimeout();
63
64    /**
65     * Wait according the wait type
66     */
67    void waitForTask();
68
69    /**
70     * Invoked by the threadpool when it wants to stop the task
71     */
72    void stopTask();
73
74    /**
75     * The task has been accepted
76     *
77     */
78    void acceptTask();
79
80    /**
81     * The task has been rejected
82     *
83     * @param e any error associated with the rejection
84     */
85    void rejectTask(RuntimeException JavaDoc e);
86
87    // Inner classes -------------------------------------------------
88 boolean isComplete();
89 }
90
Popular Tags