001    /* LifespanPolicyValue.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 object life span policy.
051    *
052    * This enumeration can obtain the following values:
053    * <ul>
054    * <li>TRANSIENT The objects implemented in the POA never outlive
055    *  the POA instance in which they are first created.</li>
056    * <li>PERSISTENT The mentioned objects can outlive the process in
057    * which they are first created.</li>
058    * </ul>
059    * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
060    */
061    public class LifespanPolicyValue
062      implements Serializable, IDLEntity
063    {
064      /**
065       * Use serialVersionUID (V1.4) for interoperability.
066       */
067      private static final long serialVersionUID = 6604562925399671611L;
068    
069      /**
070       * The value field for the current instance.
071       */
072      private final int _value;
073    
074      /**
075      * The possible value of this enumeration (TRANSIENT).
076      */
077      public static final int _TRANSIENT = 0;
078    
079      /**
080       * An instance of LifespanPolicyValue, initialized to TRANSIENT.
081       */
082      public static final LifespanPolicyValue TRANSIENT =
083        new LifespanPolicyValue(_TRANSIENT);
084    
085      /**
086      * The possible value of this enumeration (PERSISTENT).
087      */
088      public static final int _PERSISTENT = 1;
089    
090      /**
091       * An instance of LifespanPolicyValue, initialized to PERSISTENT.
092       */
093      public static final LifespanPolicyValue PERSISTENT =
094        new LifespanPolicyValue(_PERSISTENT);
095    
096      /**
097       * The private array that maps integer codes to the enumeration
098       * values.
099       */
100      private static final LifespanPolicyValue[] enume =
101        new LifespanPolicyValue[] { TRANSIENT, PERSISTENT };
102    
103      /**
104       * The private array of state names.
105       */
106      private static final String[] state_names =
107        new String[] { "TRANSIENT", "PERSISTENT" };
108    
109      /**
110       * Normally, no new instances are required, so the constructor is protected.
111       */
112      protected LifespanPolicyValue(int a_value)
113      {
114        _value = a_value;
115      }
116    
117      /**
118       * Returns the LifespanPolicyValue, matching the given integer constant.
119       *
120       * @param code one of _TRANSIENT, _PERSISTENT.
121       * @return one of TRANSIENT, PERSISTENT.
122       * @throws BAD_PARAM if the parameter is not one of the valid values.
123       */
124      public static LifespanPolicyValue 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 _TRANSIENT or _PERSISTENT.
150       */
151      public int value()
152      {
153        return _value;
154      }
155    }