KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > exolab > jms > service > ServiceState


1 /**
2  * Redistribution and use of this software and associated documentation
3  * ("Software"), with or without modification, are permitted provided
4  * that the following conditions are met:
5  *
6  * 1. Redistributions of source code must retain copyright
7  * statements and notices. Redistributions must also contain a
8  * copy of this document.
9  *
10  * 2. Redistributions in binary form must reproduce the
11  * above copyright notice, this list of conditions and the
12  * following disclaimer in the documentation and/or other
13  * materials provided with the distribution.
14  *
15  * 3. The name "Exolab" must not be used to endorse or promote
16  * products derived from this Software without prior written
17  * permission of Exoffice Technologies. For written permission,
18  * please contact info@exolab.org.
19  *
20  * 4. Products derived from this Software may not be called "Exolab"
21  * nor may "Exolab" appear in their names without prior written
22  * permission of Exoffice Technologies. Exolab is a registered
23  * trademark of Exoffice Technologies.
24  *
25  * 5. Due credit should be given to the Exolab Project
26  * (http://www.exolab.org/).
27  *
28  * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30  * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32  * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39  * OF THE POSSIBILITY OF SUCH DAMAGE.
40  *
41  * Copyright 1999-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42  */
43 package org.exolab.jms.service;
44
45
46 /**
47  * This class defines an enumeration of service states.
48  *
49  * stopped the service is not running
50  * running the service is running
51  *
52  * @version $Revision: 1.1 $ $Date: 2004/11/26 01:51:01 $
53  * @author <a HREF="mailto:jima@comware.com.au">Jim Alateras</a>
54  */
55 public final class ServiceState {
56
57     /**
58      * Instatiate instances related to each of the enumerations
59      */
60     public static final ServiceState STOPPED = new ServiceState("stopped");
61     public static final ServiceState RUNNING = new ServiceState("running");
62
63     private static int _upperSentinel = 0;
64
65     /**
66      * The state name
67      */
68     private String JavaDoc _state;
69
70     /**
71      * The ordinal value of the state
72      */
73     private int _ord;
74
75     /**
76      * Limit the creation scope of this object. All instances of this
77      * class are created at class initialisation time.
78      *
79      * @param state the state name
80      */
81     private ServiceState(String JavaDoc state) {
82         _state = state;
83         _ord = _upperSentinel++;
84     }
85
86     /**
87      * Returns the ordinal value for this state
88      *
89      * @return the ordinal value of the state
90      */
91     public int getOrd() {
92         return _ord;
93     }
94
95     /**
96      * Returns the name of this state
97      *
98      * @return the state name
99      */
100     public String JavaDoc toString() {
101         return _state;
102     }
103
104     /**
105      * Returns the number of states in this enumeration
106      *
107      * @return the number of states in the enumeration
108      */
109     public static int size() {
110         return _upperSentinel;
111     }
112
113     /**
114      * Return true if the two specified object are of the same type
115      * and their ordinal values are the same.
116      *
117      * @param object the object to compare against
118      * @return true if the two objects are equivalent
119      */
120     public boolean equals(Object JavaDoc object) {
121         boolean equal = (object == this);
122         if (!equal && object instanceof ServiceState) {
123             equal = (_ord == ((ServiceState) object)._ord);
124         }
125
126         return equal;
127     }
128
129     /**
130      * Return true if this object represents the 'running' state and false
131      * otherwise
132      *
133      * @return true if this state is the 'running' state
134      */
135     public boolean isRunning() {
136         return getOrd() == RUNNING.getOrd();
137     }
138
139     /**
140      * Return true if this object represents the 'stopped' state and false
141      * otherwise
142      *
143      * @return true if this state is the 'stopped' state
144      */
145     public boolean isStopped() {
146         return getOrd() == STOPPED.getOrd();
147     }
148
149 }
150
Popular Tags