001/* CurrentHelper.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.OrbRestricted;
042
043import org.omg.CORBA.Any;
044import org.omg.CORBA.BAD_OPERATION;
045import org.omg.CORBA.TypeCode;
046import org.omg.CORBA.portable.Delegate;
047import org.omg.CORBA.portable.InputStream;
048import org.omg.CORBA.portable.ObjectImpl;
049import org.omg.CORBA.portable.OutputStream;
050
051/**
052* The helper operations for the CORBA object {@link Current}.
053*
054* @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
055*/
056public abstract class CurrentHelper
057{
058  /**
059   * The Current stub (proxy), used on the client side.
060   * The {@link Current} methods should contain the code for remote
061   * invocaton. As there are no methods defined, this class is only
062   * used for the formal support of the
063   * {@link #narrow(org.omg.CORBA.Object)}.
064   */
065  private static class _CurrentStub
066    extends ObjectImpl
067    implements Current
068  {
069    /**
070     * Create the naming context stub with the given delegate.
071     */
072    public _CurrentStub(Delegate delegate)
073    {
074      _set_delegate(delegate);
075    }
076
077    /**
078     * Return the array of repository ids for this object.
079     */
080    public String[] _ids()
081    {
082      return new String[] { id() };
083    }
084  }
085
086  /**
087   * Get the type code of the {@link Current}.
088   */
089  public static TypeCode type()
090  {
091    return
092      OrbRestricted.Singleton.create_interface_tc(id(), "Current");
093  }
094
095  /**
096   * Insert the Current into the given Any.
097   *
098   * @param any the Any to insert into.
099   * @param that the Current to insert.
100   */
101  public static void insert(Any any, Current that)
102  {
103    any.insert_Object(that);
104  }
105
106  /**
107   * Extract the Current from given Any.
108   *
109   * @throws BAD_OPERATION if the passed Any does not contain Current.
110   */
111  public static Current extract(Any any)
112  {
113    return narrow(any.extract_Object());
114  }
115
116  /**
117   * Get the Current repository id.
118   *
119   * @return "IDL:omg.org/CORBA/Current:1.0", always.
120   */
121  public static String id()
122  {
123    return "IDL:omg.org/CORBA/Current:1.0";
124  }
125
126  /**
127   * Cast the passed object into the Current. If the
128   * object has a different java type, create an instance
129   * of the _CurrentStub, using the same delegate, as for
130   * the passed parameter. Hence, unlike java type cast,
131   * this method may return a different object, than has been passed.
132   *
133   * @param obj the object to narrow.
134   * @return narrowed instance.
135   *
136   * @throws BAD_PARAM if the passed object is not a Current.
137   */
138  public static Current narrow(org.omg.CORBA.Object obj)
139  {
140    if (obj == null)
141      return null;
142    else if (obj instanceof Current)
143      return (Current) obj;
144    else if (!obj._is_a(id()))
145      throw new BAD_PARAM("Not a Current");
146    else
147      {
148        Delegate delegate = ((ObjectImpl) obj)._get_delegate();
149        return new _CurrentStub(delegate);
150      }
151  }
152
153  /**
154   * Read the Current from the CDR intput stream (IOR profile expected).
155   *
156   * @param input a org.omg.CORBA.portable stream to read from.
157   */
158  public static Current read(InputStream input)
159  {
160    return narrow(input.read_Object());
161  }
162
163  /**
164   * Write the Current to the CDR output stream (as IOR profile).
165   *
166   * @param output a org.omg.CORBA.portable stream stream to write into.
167   * @param value a value to write.
168   */
169  public static void write(OutputStream output, Current value)
170  {
171    output.write_Object(value);
172  }
173}