001/* ObjectReferenceFactoryHelper.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.PortableInterceptor;
040
041import gnu.CORBA.CDR.Vio;
042import gnu.CORBA.Minor;
043import gnu.CORBA.OrbRestricted;
044
045import org.omg.CORBA.Any;
046import org.omg.CORBA.BAD_OPERATION;
047import org.omg.CORBA.TypeCode;
048import org.omg.CORBA.ValueMember;
049import org.omg.CORBA.portable.InputStream;
050import org.omg.CORBA.portable.OutputStream;
051import org.omg.CORBA.VM_ABSTRACT;
052
053/**
054 * The helper operations for the CORBA object {@link ObjectReferenceFactory}.
055 *
056 * @since 1.5
057 *
058 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
059 */
060public abstract class ObjectReferenceFactoryHelper
061{
062  /**
063   * Get the type code of the {@link ObjectReferenceFactory}.
064   *
065   * @return value type code with the agreed id, named "ObjectReferenceFactory",
066   *         abstract, no members, no base type.
067   */
068  public static TypeCode type()
069  {
070    return OrbRestricted.Singleton.create_value_tc(id(), "ObjectReferenceFactory",
071                                      VM_ABSTRACT.value, null,
072                                      new ValueMember[0]);
073  }
074
075  /**
076   * Insert the ObjectReferenceFactory into the given Any.
077   *
078   * @param any the Any to insert into.
079   * @param that the ObjectReferenceFactory to insert.
080   */
081  public static void insert(Any any, ObjectReferenceFactory that)
082  {
083    ObjectReferenceFactoryHolder h = new ObjectReferenceFactoryHolder(that);
084    any.insert_Streamable(h);
085  }
086
087  /**
088   * Extract the ObjectReferenceFactory from given Any.
089   *
090   * @throws BAD_OPERATION if the passed Any does not contain ObjectReferenceFactory.
091   */
092  public static ObjectReferenceFactory extract(Any any)
093  {
094    try
095      {
096        ObjectReferenceFactoryHolder h =
097          (ObjectReferenceFactoryHolder) (any.extract_Streamable());
098        return h.value;
099      }
100    catch (ClassCastException ex)
101      {
102        BAD_OPERATION bad =
103          new BAD_OPERATION("ObjectReferenceFactory expected");
104        bad.minor = Minor.Any;
105        bad.initCause(ex);
106        throw bad;
107      }
108  }
109
110  /**
111   * Get the ObjectReferenceFactory repository id.
112   *
113   * @return "IDL:omg.org/PortableInterceptor/ObjectReferenceFactory:1.0",
114   * always.
115   */
116  public static String id()
117  {
118    return "IDL:omg.org/PortableInterceptor/ObjectReferenceFactory:1.0";
119  }
120
121  /**
122   * Read the ObjectReferenceFactory from the CDR intput stream
123   * (ValueBase type expected).
124   *
125   * @param input a org.omg.CORBA.portable stream to read from.
126   */
127  public static ObjectReferenceFactory read(InputStream input)
128  {
129    return (ObjectReferenceFactory) Vio.read(input);
130  }
131
132  /**
133   * Write the ObjectReferenceFactory to the CDR output stream (as a ValueBase).
134   *
135   * @param output a org.omg.CORBA.portable stream stream to write into.
136   * @param value a value to write.
137   */
138  public static void write(OutputStream output, ObjectReferenceFactory value)
139  {
140    Vio.write(output, value);
141  }
142}