001    /* ServantRetentionPolicyValue.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 servant retention policy.
051    *
052    * This enumeration can obtain the following values:
053    * <ul>
054    * <li>RETAIN The POA retains active servants in its Active Object Map.</li>
055    * <li>NON_RETAIN The servants are not retained.</li>
056    * </ul>
057    * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
058    */
059    public class ServantRetentionPolicyValue
060      implements Serializable, IDLEntity
061    {
062      /**
063       * Use serialVersionUID (V1.4) for interoperability.
064       */
065      private static final long serialVersionUID = -7476100336036943822L;
066    
067      /**
068       * The value field for the current instance.
069       */
070      private final int _value;
071    
072      /**
073      * The possible value of this enumeration (RETAIN).
074      */
075      public static final int _RETAIN = 0;
076    
077      /**
078       * An instance of ServantRetentionPolicyValue, indicating that
079       * the POA retains active servants in its Active Object Map.
080       */
081      public static final ServantRetentionPolicyValue RETAIN =
082        new ServantRetentionPolicyValue(_RETAIN);
083    
084      /**
085      * The possible value of this enumeration (NON_RETAIN).
086      */
087      public static final int _NON_RETAIN = 1;
088    
089      /**
090       * An instance of ServantRetentionPolicyValue, indicating that
091       * the POA does not use the Active Object Map.
092       */
093      public static final ServantRetentionPolicyValue NON_RETAIN =
094        new ServantRetentionPolicyValue(_NON_RETAIN);
095    
096      /**
097       * The private array that maps integer codes to the enumeration
098       * values.
099       */
100      private static final ServantRetentionPolicyValue[] enume =
101        new ServantRetentionPolicyValue[] { RETAIN, NON_RETAIN };
102    
103      /**
104       * The private array of state names.
105       */
106      private static final String[] state_names =
107        new String[] { "RETAIN", "NON_RETAIN" };
108    
109      /**
110       * Normally, no new instances are required, so the constructor is protected.
111       */
112      protected ServantRetentionPolicyValue(int a_value)
113      {
114        _value = a_value;
115      }
116    
117      /**
118       * Returns the ServantRetentionPolicyValue, matching the given integer constant.
119       *
120       * @param code one of _RETAIN, _NON_RETAIN.
121       * @return one of RETAIN, NON_RETAIN.
122       * @throws BAD_PARAM if the parameter is not one of the valid values.
123       */
124      public static ServantRetentionPolicyValue from_int(int code)
125      {
126        try
127          {
128            return enume [ code ];
129          }
130        catch (ArrayIndexOutOfBoundsException ex)
131          {
132            BAD_OPERATION bad = new BAD_OPERATION("Invalid policy code " + code);
133            bad.minor = Minor.PolicyType;
134            throw bad;
135          }
136      }
137    
138      /**
139       * Returns a short string representation.
140       * @return the name of the current enumeration value.
141       */
142      public String toString()
143      {
144        return state_names [ _value ];
145      }
146    
147      /**
148       * Returns the integer code of the policy value.
149       * @return _RETAIN or _NON_RETAIN.
150       */
151      public int value()
152      {
153        return _value;
154      }
155    }