Dead
[official-gcc.git] / gomp-20050608-branch / libjava / classpath / org / omg / PortableServer / ThreadPolicyValue.java
blob5c771a7d62495935c0a04ca4a86091270ff86ebb
1 /* ThreadPolicyValue.java --
2 Copyright (C) 2005 Free Software Foundation, Inc.
4 This file is part of GNU Classpath.
6 GNU Classpath is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
11 GNU Classpath is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Classpath; see the file COPYING. If not, write to the
18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 02110-1301 USA.
21 Linking this library statically or dynamically with other modules is
22 making a combined work based on this library. Thus, the terms and
23 conditions of the GNU General Public License cover the whole
24 combination.
26 As a special exception, the copyright holders of this library give you
27 permission to link this library with independent modules to produce an
28 executable, regardless of the license terms of these independent
29 modules, and to copy and distribute the resulting executable under
30 terms of your choice, provided that you also meet, for each linked
31 independent module, the terms and conditions of the license of that
32 module. An independent module is a module which is not derived from
33 or based on this library. If you modify this library, you may extend
34 this exception to your version of the library, but you are not
35 obligated to do so. If you do not wish to do so, delete this
36 exception statement from your version. */
39 package org.omg.PortableServer;
41 import gnu.CORBA.Minor;
43 import org.omg.CORBA.BAD_OPERATION;
44 import org.omg.CORBA.portable.IDLEntity;
46 import java.io.Serializable;
48 /**
49 * Defines the possible values for the POA thread policy.
51 * This enumeration can obtain the following values:
52 * <ul>
53 * <li>ORB_CTRL_MODEL Each object in POA has a separate serving thread
54 * and a separate server socket, listening on the objects individual
55 * port. Additionally, when the request is accepted, it is also
56 * served in a separate thread, so several requests to the same
57 * object can be processed in parallel. The servant can always get
58 * the Id and POA of the object it is currently serving by
59 * invoking {@link Servant#_object_id()} and {@link Servant#_poa}.
60 * These two methods use thread to data map and must work correctly
61 * even then the servant code is executed in several parallel threads.
62 * </li>
63 * <li>SINGLE_THREAD_MODEL All objects in POA share the same server
64 * socket and are served in the same thread. This model is applicable
65 * when the number of objects is greater than the number of threads
66 * and (or) ports, supported by the system.</li>
67 * </ul>
68 * OMG also defines a MAIN_THREAD_MODEL, currently not supported by
69 * the java API.
71 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
73 public class ThreadPolicyValue
74 implements Serializable, IDLEntity
76 /**
77 * Use serialVersionUID (v1.4) for interoperability.
79 private static final long serialVersionUID = -8874988828297141512L;
81 /**
82 * The value field for the current instance.
84 private final int _value;
86 /**
87 * The possible value of this enumeration (ORB_CTRL_MODEL).
89 public static final int _ORB_CTRL_MODEL = 0;
91 /**
92 * An instance of ThreadPolicyValue, initialized to ORB_CTRL_MODEL.
94 public static final ThreadPolicyValue ORB_CTRL_MODEL =
95 new ThreadPolicyValue(_ORB_CTRL_MODEL);
97 /**
98 * The possible value of this enumeration (SINGLE_THREAD_MODEL).
100 public static final int _SINGLE_THREAD_MODEL = 1;
103 * An instance of ThreadPolicyValue, initialized to SINGLE_THREAD_MODEL.
105 public static final ThreadPolicyValue SINGLE_THREAD_MODEL =
106 new ThreadPolicyValue(_SINGLE_THREAD_MODEL);
109 * The private array that maps integer codes to the enumeration
110 * values.
112 private static final ThreadPolicyValue[] enume =
113 new ThreadPolicyValue[] { ORB_CTRL_MODEL, SINGLE_THREAD_MODEL };
116 * The private array of state names.
118 private static final String[] state_names =
119 new String[] { "ORB_CTRL_MODEL", "SINGLE_THREAD_MODEL" };
122 * Normally, no new instances are required, so the constructor is protected.
124 protected ThreadPolicyValue(int a_value)
126 _value = a_value;
130 * Returns the ThreadPolicyValue, matching the given integer constant.
132 * @param code one of _ORB_CTRL_MODEL, _SINGLE_THREAD_MODEL.
133 * @return one of ORB_CTRL_MODEL, SINGLE_THREAD_MODEL.
134 * @throws BAD_PARAM if the parameter is not one of the valid values.
136 public static ThreadPolicyValue from_int(int code)
140 return enume [ code ];
142 catch (ArrayIndexOutOfBoundsException ex)
144 BAD_OPERATION bad = new BAD_OPERATION("Invalid policy code " + code);
145 bad.minor = Minor.PolicyType;
146 throw bad;
151 * Returns a short string representation.
152 * @return the name of the current enumeration value.
154 public String toString()
156 return state_names [ _value ];
160 * Returns the integer code of the enumeration value.
161 * @return one of ORB_CTRL_MODEL, SINGLE_THREAD_MODEL.
163 public int value()
165 return _value;