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.PortableInterceptor;
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.BAD_PARAM;
047import org.omg.CORBA.MARSHAL;
048import org.omg.CORBA.TypeCode;
049import org.omg.CORBA.portable.InputStream;
050import org.omg.CORBA.portable.OutputStream;
051
052/**
053 * The helper operations for the CORBA object {@link Current}.
054 *
055 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
056 */
057public abstract class CurrentHelper
058{
059  /**
060   * Get the type code of the {@link Current}.
061   */
062  public static TypeCode type()
063  {
064    return OrbRestricted.Singleton.create_interface_tc(id(), "Current");
065  }
066
067  /**
068   * Insert the Current into the given Any.
069   *
070   * @param any the Any to insert into.
071   * @param that the Current to insert.
072   */
073  public static void insert(Any any, Current that)
074  {
075    any.insert_Object(that);
076  }
077
078  /**
079   * Extract the Current from given Any.
080   *
081   * @throws BAD_OPERATION if the passed Any does not contain Current.
082   */
083  public static Current extract(Any any)
084  {
085    return narrow(any.extract_Object());
086  }
087
088  /**
089   * Get the Current repository id.
090   *
091   * @return "org.omg.PortableInterceptor.CurrentOperations", always.
092   */
093  public static String id()
094  {
095    return "IDL:omg.org/PortableInterceptor/Current:1.0";
096  }
097
098  /**
099   * Cast the passed object into the Current.
100   *
101   * @param obj the object to narrow.
102   * @return narrowed instance.
103   * @throws BAD_PARAM if the passed object is not a Current.
104   */
105  public static Current narrow(org.omg.CORBA.Object obj)
106  {
107    if (obj == null)
108      {
109        return null;
110      }
111    else if (obj instanceof Current)
112      {
113        return (Current) obj;
114      }
115    else
116      {
117        throw new BAD_PARAM("Not a Current");
118      }
119  }
120  
121  /**
122   * Narrow the given object to the Current. For the objects that are
123   * always local, this operation does not differ from the ordinary
124   * {@link #narrow} (ClassCastException will be thrown if narrowing something
125   * different). See also OMG issue 4158.
126   * 
127   * @param obj the object to cast.
128   * 
129   * @return the casted Current.
130   * 
131   * @since 1.5 
132   */
133  public static Current unchecked_narrow(org.omg.CORBA.Object obj)
134  {
135    return narrow(obj);
136  }    
137
138  /**
139   * Not supported for compatibility reasons.
140   *
141   * @specnote Not supported by Sun at least till jdk 1.5 inclusive.
142   *
143   * @throws MARSHAL always.
144   */
145  public static Current read(InputStream input)
146  {
147    MARSHAL m = new MARSHAL("Inappropriate");
148    m.minor = Minor.Inappropriate;
149    throw m;
150  }
151
152  /**
153   * Not supported for compatibility reasons.
154   *
155   * @specnote Not supported by Sun at least till jdk 1.5 inclusive.
156   *
157   * @throws MARSHAL always.
158   */
159  public static void write(OutputStream output, Current value)
160  {
161    MARSHAL m = new MARSHAL("Inappropriate");
162    m.minor = Minor.Inappropriate;
163    throw m;
164  }
165}