001/* PolicyHelper.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.CORBA;
040
041import gnu.CORBA.Minor;
042import gnu.CORBA.OrbRestricted;
043
044import org.omg.CORBA.Any;
045import org.omg.CORBA.BAD_OPERATION;
046import org.omg.CORBA.TypeCode;
047import org.omg.CORBA.portable.Delegate;
048import org.omg.CORBA.portable.InputStream;
049import org.omg.CORBA.portable.ObjectImpl;
050import org.omg.CORBA.portable.OutputStream;
051
052/**
053* The helper operations for the
054* CORBA object {@link Policy}.
055*
056* @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
057*/
058public abstract class PolicyHelper
059{
060  /**
061   * Get the type code of the {@link Policy}.
062   *
063   * @return interface typecode, named "Policy".
064   */
065  public static TypeCode type()
066  {
067    return OrbRestricted.Singleton.create_interface_tc(id(), "Policy");
068  }
069
070  /**
071   * Insert the Policy into the given Any.
072   *
073   * @param any the Any to insert into.
074   * @param that the Policy to insert.
075   */
076  public static void insert(Any any, Policy that)
077  {
078    any.insert_Streamable(new PolicyHolder(that));
079  }
080
081  /**
082   * Extract the Policy from given Any.
083   *
084   * @throws BAD_OPERATION if the passed Any does not contain Policy.
085   */
086  public static Policy extract(Any any)
087  {
088    try
089      {
090        PolicyHolder h = (PolicyHolder) any.extract_Streamable();
091        return h.value;
092      }
093    catch (ClassCastException ex)
094      {
095        BAD_OPERATION bad = new BAD_OPERATION("Policy expected");
096        bad.minor = Minor.Any;
097        throw bad;
098      }
099  }
100
101  /**
102   * Get the Policy repository id.
103   *
104   * @return "IDL:omg.org/CORBA/Policy:1.0", always.
105   */
106  public static String id()
107  {
108    return "IDL:omg.org/CORBA/Policy:1.0";
109  }
110
111  /**
112   * Cast the passed object into the Policy. If the
113   * object has a different java type, create an instance
114   * of the _PolicyStub, using the same delegate, as for
115   * the passed parameter. Hence, unlike java type cast,
116   * this method may return a different object, than has been passed.
117   *
118   * @param obj the object to narrow.
119   * @return narrowed instance.
120   * @throws BAD_PARAM if the passed object is not a Policy.
121   */
122  public static Policy narrow(org.omg.CORBA.Object obj)
123  {
124    if (obj == null)
125      return null;
126    else if (obj instanceof Policy)
127      return (Policy) obj;
128    else
129      {
130        // Check for the policy id cannot be performed because
131        // this helper must read various subclasses of the Policy,
132        // and the IOR profile currently supports only one id.
133
134        Delegate delegate = ((ObjectImpl) obj)._get_delegate();
135        return new _PolicyStub(delegate);
136      }
137  }
138
139  /**
140   * Read the object from the CDR intput stream (IOR profile expected).
141   *
142   * @param input a org.omg.CORBA.portable stream to read from.
143   */
144  public static Policy read(InputStream input)
145  {
146    return narrow(input.read_Object());
147  }
148
149  /**
150   * Write the object to the CDR output stream (as IOR profile).
151   *
152   * @param output a org.omg.CORBA.portable stream stream to write into.
153   * @param value a value to write.
154   */
155  public static void write(OutputStream output, Policy value)
156  {
157    output.write_Object(value);
158  }
159}