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