001    /* RequestProcessingPolicyValue.java --
002       Copyright (C) 2005, 2006 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package org.omg.PortableServer;
040    
041    import gnu.CORBA.Minor;
042    
043    import org.omg.CORBA.BAD_OPERATION;
044    import org.omg.CORBA.BAD_PARAM;
045    import org.omg.CORBA.portable.IDLEntity;
046    
047    import java.io.Serializable;
048    
049    /**
050    * Specifies the behaviour in the case when the
051    * requested object is not found in the Active Object Map or that map
052    * is not in use. The map is not in use when the
053    * {@link ServantRetentionPolicyValue#NON_RETAIN} policy is active.
054    * <ul>
055    * <li>USE_ACTIVE_OBJECT_MAP_ONLY Raise an {@link org.omg.CORBA.OBJECT_NOT_EXIST}
056    * with the minor code 2. {@link ServantRetentionPolicyValue#RETAIN} policy is
057    * also required.
058    * </li>
059    * <li>USE_DEFAULT_SERVANT Dispatch request to the default servant. If no such
060    * exists, raise {@link org.omg.CORBA.OBJ_ADAPTER} with minor code 3.
061    * {@link IdUniquenessPolicyValue#MULTIPLE_ID} is also required.
062    * </li>
063    * <li>USE_SERVANT_MANAGER Dispatch request to the servant manager. If no such
064    * exists, raise {@link org.omg.CORBA.OBJ_ADAPTER} with the minor code 4.</li>
065    * </ul>
066    *
067    * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
068    */
069    public class RequestProcessingPolicyValue
070      implements Serializable, IDLEntity
071    {
072      /**
073       * Use serialVersionUID (V1.4) for interoperability.
074       */
075      private static final long serialVersionUID = 7646563512329907695L;
076    
077      /**
078       * The value field for the current instance.
079       */
080      private final int _value;
081    
082      /**
083      * The possible value of this enumeration (USE_ACTIVE_OBJECT_MAP_ONLY).
084      */
085      public static final int _USE_ACTIVE_OBJECT_MAP_ONLY = 0;
086    
087      /**
088       * An instance of RequestProcessingPolicyValue, initialized to USE_ACTIVE_OBJECT_MAP_ONLY.
089       */
090      public static final RequestProcessingPolicyValue USE_ACTIVE_OBJECT_MAP_ONLY =
091        new RequestProcessingPolicyValue(_USE_ACTIVE_OBJECT_MAP_ONLY);
092    
093      /**
094      * The possible value of this enumeration (USE_DEFAULT_SERVANT).
095      */
096      public static final int _USE_DEFAULT_SERVANT = 1;
097    
098      /**
099       * An instance of RequestProcessingPolicyValue, initialized to USE_DEFAULT_SERVANT.
100       */
101      public static final RequestProcessingPolicyValue USE_DEFAULT_SERVANT =
102        new RequestProcessingPolicyValue(_USE_DEFAULT_SERVANT);
103    
104      /**
105      * The possible value of this enumeration (USE_SERVANT_MANAGER).
106      */
107      public static final int _USE_SERVANT_MANAGER = 2;
108    
109      /**
110       * An instance of RequestProcessingPolicyValue, initialized to USE_SERVANT_MANAGER.
111       */
112      public static final RequestProcessingPolicyValue USE_SERVANT_MANAGER =
113        new RequestProcessingPolicyValue(_USE_SERVANT_MANAGER);
114    
115      /**
116       * The private array that maps integer codes to the enumeration
117       * values.
118       */
119      private static final RequestProcessingPolicyValue[] enume =
120        new RequestProcessingPolicyValue[]
121        {
122          USE_ACTIVE_OBJECT_MAP_ONLY, USE_DEFAULT_SERVANT, USE_SERVANT_MANAGER
123        };
124    
125      /**
126       * The private array of state names.
127       */
128      private static final String[] state_names =
129        new String[]
130        {
131          "USE_ACTIVE_OBJECT_MAP_ONLY", "USE_DEFAULT_SERVANT", "USE_SERVANT_MANAGER"
132        };
133    
134      /**
135       * Normally, no new instances are required, so the constructor is protected.
136       */
137      protected RequestProcessingPolicyValue(int a_value)
138      {
139        _value = a_value;
140      }
141    
142      /**
143       * Returns the RequestProcessingPolicyValue, matching the given integer constant.
144       *
145       * @param code one of _USE_ACTIVE_OBJECT_MAP_ONLY, _USE_DEFAULT_SERVANT, _USE_SERVANT_MANAGER.
146       * @return one of USE_ACTIVE_OBJECT_MAP_ONLY, USE_DEFAULT_SERVANT, USE_SERVANT_MANAGER.
147       * @throws BAD_PARAM if the parameter is not one of the valid values.
148       */
149      public static RequestProcessingPolicyValue from_int(int code)
150      {
151        try
152          {
153            return enume [ code ];
154          }
155        catch (ArrayIndexOutOfBoundsException ex)
156          {
157            BAD_OPERATION bad = new BAD_OPERATION("Invalid policy code " + code);
158            bad.minor = Minor.PolicyType;
159            throw bad;
160          }
161      }
162    
163      /**
164       * Returns a short string representation.
165       * @return the name of the current enumeration value.
166       */
167      public String toString()
168      {
169        return state_names [ _value ];
170      }
171    
172      /**
173       * Returns the integer code of the policy value.
174       * @return one of _USE_ACTIVE_OBJECT_MAP_ONLY,
175       * _USE_DEFAULT_SERVANT, _USE_SERVANT_MANAGER.
176       */
177      public int value()
178      {
179        return _value;
180      }
181    }