KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mr > core > util > StageParams


1 /*
2  * Copyright 2002 by
3  * <a HREF="http://www.coridan.com">Coridan</a>
4  * <a HREF="mailto: support@coridan.com ">support@coridan.com</a>
5  *
6  * The contents of this file are subject to the Mozilla Public License Version
7  * 1.1 (the "License"); you may not use this file except in compliance with the
8  * License. You may obtain a copy of the License at
9  * http://www.mozilla.org/MPL/
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the
14  * License.
15  *
16  * The Original Code is "MantaRay" (TM).
17  *
18  * The Initial Developer of the Original Code is Amir Shevat.
19  * Portions created by the Initial Developer are Copyright (C) 2006
20  * Coridan Inc. All Rights Reserved.
21  *
22  * Contributor(s): all the names of the contributors are added in the source
23  * code where applicable.
24  *
25  * Alternatively, the contents of this file may be used under the terms of the
26  * LGPL license (the "GNU LESSER GENERAL PUBLIC LICENSE"), in which case the
27  * provisions of LGPL are applicable instead of those above. If you wish to
28  * allow use of your version of this file only under the terms of the LGPL
29  * License and not to allow others to use your version of this file under
30  * the MPL, indicate your decision by deleting the provisions above and
31  * replace them with the notice and other provisions required by the LGPL.
32  * If you do not delete the provisions above, a recipient may use your version
33  * of this file under either the MPL or the GNU LESSER GENERAL PUBLIC LICENSE.
34  
35  *
36  * This library is free software; you can redistribute it and/or modify it
37  * under the terms of the MPL as stated above or under the terms of the GNU
38  * Lesser General Public License as published by the Free Software Foundation;
39  * either version 2.1 of the License, or any later version.
40  *
41  * This library is distributed in the hope that it will be useful, but WITHOUT
42  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
43  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
44  * License for more details.
45  */
46 /*
47  * Created on Dec 14, 2003
48  *
49  */
50 package org.mr.core.util;
51
52 /**
53  * Holds all the parameters a stage needs.
54  * @author Amir Shevat
55  *
56  */
57 public class StageParams {
58     /**
59      * a <b>Unique</b> name
60      */
61     private String JavaDoc stageName;
62     /**
63      * if true this Stage will be persistent
64      */
65     private boolean persistent = false;
66     /**
67      * if true and persistent = true this stage will block on enqueue untill persistent
68      */
69     private boolean blocking = false;
70     /**
71      * the stage starts with this amount of StageExecutionThread
72      */
73     private int numberOfStartThreads = 1;
74     /**
75      * the stage will have no more then this number of StageExecutionThread
76      */
77     private int maxNumberOfThreads = 10;
78     /**
79      * the handler of this stage
80      */
81     private StageHandler handler;
82     
83     
84     private int stagePriority =0;
85     /**
86      * @return True if the stage is blocking.
87      */
88     public boolean isBlocking() {
89         return blocking;
90     }
91
92     /**
93      * @param blocking The blocking value to set.
94      */
95     public void setBlocking(boolean blocking) {
96         this.blocking = blocking;
97     }
98
99     /**
100      * @return The maxNumberOfThreads.
101      */
102     public int getMaxNumberOfThreads() {
103         return maxNumberOfThreads;
104     }
105
106     /**
107      * @param maxNumberOfThreads The maxNumberOfThreads to set.
108      */
109     public void setMaxNumberOfThreads(int maxNumberOfThreads) {
110         this.maxNumberOfThreads = maxNumberOfThreads;
111     }
112
113     /**
114      * @return The numberOfStartThreads.
115      */
116     public int getNumberOfStartThreads() {
117         return numberOfStartThreads;
118     }
119
120     /**
121      * @param numberOfStartThreads The numberOfStartThreads to set.
122      */
123     public void setNumberOfStartThreads(int numberOfStartThreads) {
124         this.numberOfStartThreads = numberOfStartThreads;
125     }
126
127     /**
128      * @return True if persistent.
129      */
130     public boolean isPersistent() {
131         return persistent;
132     }
133
134     /**
135      * @param persistent The persistent value to set.
136      */
137     public void setPersistent(boolean persistent) {
138         this.persistent = persistent;
139     }
140
141     /**
142      * @return The stageName.
143      */
144     public String JavaDoc getStageName() {
145         return stageName;
146     }
147
148     /**
149      * @param stageName The stageName to set.
150      */
151     public void setStageName(String JavaDoc stageName) {
152         this.stageName = stageName;
153     }
154
155     /**
156      * @return The stage handler.
157      */
158     public StageHandler getHandler() {
159         return handler;
160     }
161
162     /**
163      * @param handler The handler to set.
164      */
165     public void setHandler(StageHandler handler) {
166         this.handler = handler;
167     }
168
169     /**
170      * @return The stagePriority.
171      */
172     public int getStagePriority() {
173         return stagePriority;
174     }
175
176     /**
177      * @param stagePriority The stagePriority to set.
178      */
179     public void setStagePriority(int stagePriority) {
180         if(stagePriority >5 || stagePriority < -4)
181             throw new IllegalArgumentException JavaDoc("invalid priorety "+stagePriority+": (5> priorety <-4)");
182         this.stagePriority = stagePriority;
183     }
184
185 }
186
Popular Tags