Source Code Cross Referenced for Enum.java in  » Workflow-Engines » obe-1.0 » org » obe » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

01:        /*--
02:
03:         Copyright (C) 2002-2005 Adrian Price.
04:         All rights reserved.
05:
06:         Redistribution and use in source and binary forms, with or without
07:         modification, are permitted provided that the following conditions
08:         are met:
09:
10:         1. Redistributions of source code must retain the above copyright
11:            notice, this list of conditions, and the following disclaimer.
12:
13:         2. Redistributions in binary form must reproduce the above copyright
14:            notice, this list of conditions, and the disclaimer that follows
15:            these conditions in the documentation and/or other materials
16:            provided with the distribution.
17:
18:         3. The names "OBE" and "Open Business Engine" must not be used to
19:         	endorse or promote products derived from this software without prior
20:         	written permission.  For written permission, please contact
21:         	adrianprice@sourceforge.net.
22:
23:         4. Products derived from this software may not be called "OBE" or
24:         	"Open Business Engine", nor may "OBE" or "Open Business Engine"
25:         	appear in their name, without prior written permission from
26:         	Adrian Price (adrianprice@users.sourceforge.net).
27:
28:         THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
29:         WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
30:         OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
31:         DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
32:         INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
33:         (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
34:         SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35:         HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
36:         STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
37:         IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38:         POSSIBILITY OF SUCH DAMAGE.
39:
40:         For more information on OBE, please see
41:         <http://obe.sourceforge.net/>.
42:
43:         */
44:
45:        package org.obe.util;
46:
47:        import java.io.Serializable;
48:        import java.util.List;
49:
50:        /**
51:         * Represents an enumerated type as described by JDK 1.5.  Implementing classes
52:         * are expected to provide the following methods:
53:         * <p/>
54:         * <code>
55:         * public static final List&lt;EnumType&gt; VALUES;<br/>
56:         * public static &lt;EnumType&gt; valueOf(String s);<br/>
57:         * public static &lt;EnumType&gt; valueOf(int i);<br/>
58:         * public final List&lt;EnumType&gt; family();<br/>
59:         * public final String compareTo(Object o);<br/>
60:         * public final String equals(Object o);<br/>
61:         * public final int hashcode();<br/>
62:         * public String toString();<br/>
63:         * protected final Object clone(Object o) throws CloneNotSupportedException<br/>
64:         * protected final Object readResolve() throws ObjectStreamException;<br/>
65:         * <code>
66:         *
67:         * @author Adrian Price
68:         */
69:        public interface Enum extends Comparable, Serializable {
70:            /**
71:             * Returns the ordinal value.
72:             *
73:             * @return Ordinal value.
74:             */
75:            int value();
76:
77:            /**
78:             * Returns an immutable list of the members of the enumerated type.
79:             *
80:             * @return The family of allowed values.
81:             */
82:            List family();
83:        }