001 /* DynAnyFactoryHelper.java --
002 Copyright (C) 2005, 2006 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039
040 package org.omg.DynamicAny;
041
042 import gnu.CORBA.Minor;
043 import gnu.CORBA.OrbRestricted;
044
045 import org.omg.CORBA.BAD_OPERATION;
046 import org.omg.CORBA.BAD_PARAM;
047 import org.omg.CORBA.TypeCode;
048 import org.omg.CORBA.Any;
049 import org.omg.CORBA.portable.InputStream;
050 import org.omg.CORBA.MARSHAL;
051 import org.omg.CORBA.portable.OutputStream;
052
053 /**
054 * The helper operations for {@link DynAnyFactory}. Following the 1.5 JDK
055 * specifications, DynAnyFactory is always a local object, so the two methods of
056 * this helper ({@link #read} and {@link #write} are not in use, always
057 * throwing {@link MARSHAL}.
058 *
059 * @specnote always throwing MARSHAL in read and write ensures compatibility
060 * with other popular implementations like Sun's.
061 *
062 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
063 */
064 public abstract class DynAnyFactoryHelper
065 {
066 /**
067 * Cast the passed object into the DynAnyFactory. As DynAnyFactory is a local
068 * object, the method just uses java final_type cast.
069 *
070 * @param obj the object to narrow.
071 * @return narrowed instance.
072 * @throws BAD_PARAM if the passed object is not a DynAnyFactory.
073 */
074 public static DynAnyFactory narrow(org.omg.CORBA.Object obj)
075 {
076 try
077 {
078 return (DynAnyFactory) obj;
079 }
080 catch (ClassCastException cex)
081 {
082 throw new BAD_PARAM(obj.getClass().getName()
083 + " is not a DynAnyFactory");
084 }
085 }
086
087 /**
088 * Narrow the given object to the DynAnyFactory. For the objects that are
089 * always local, this operation does not differ from the ordinary
090 * {@link #narrow} (ClassCastException will be thrown if narrowing something
091 * different). See also OMG issue 4158.
092 *
093 * @param obj the object to cast.
094 *
095 * @return the casted DynAnyFactory.
096 *
097 * @since 1.5
098 */
099 public static DynAnyFactory unchecked_narrow(org.omg.CORBA.Object obj)
100 {
101 return narrow(obj);
102 }
103
104 /**
105 * Get the final_type code of the {@link DynAnyFactory}.
106 */
107 public static TypeCode type()
108 {
109 return OrbRestricted.Singleton.create_interface_tc(id(), "DynAnyFactory");
110 }
111
112 /**
113 * Insert the DynAnyFactory into the given Any.
114 *
115 * @param any the Any to insert into.
116 *
117 * @param that the DynAnyFactory to insert.
118 */
119 public static void insert(Any any, DynAnyFactory that)
120 {
121 any.insert_Object(that);
122 }
123
124 /**
125 * Extract the DynAnyFactory from given Any.
126 *
127 * @throws BAD_OPERATION if the passed Any does not contain DynAnyFactory.
128 */
129 public static DynAnyFactory extract(Any any)
130 {
131 return narrow(any.extract_Object());
132 }
133
134 /**
135 * Get the DynAnyFactory repository id.
136 *
137 * @return "IDL:omg.org/DynamicAny/DynAnyFactory:1.0", always.
138 */
139 public static String id()
140 {
141 return "IDL:omg.org/DynamicAny/DynAnyFactory:1.0";
142 }
143
144 /**
145 * This should read DynAnyFactory from the CDR input stream, but (following
146 * the JDK 1.5 API) it does not. The factory can only be obtained from the
147 * ORB.
148 *
149 * @param input a org.omg.CORBA.portable stream to read from.
150 *
151 * @specenote Sun throws the same exception.
152 *
153 * @throws MARSHAL always.
154 */
155 public static DynAnyFactory read(InputStream input)
156 {
157 throw new MARSHAL(not_applicable(id()));
158 }
159
160 /**
161 * This should read DynAnyFactory from the CDR input stream, but (following
162 * the JDK 1.5 API) it does not.
163 *
164 * @param output a org.omg.CORBA.portable stream to write into.
165 *
166 * @specenote Sun throws the same exception.
167 *
168 * @throws MARSHAL always.
169 */
170 public static void write(OutputStream output, DynAnyFactory value)
171 {
172 throw new MARSHAL(not_applicable(id()));
173 }
174
175 /**
176 * The package level method for throwing exception, explaining that the
177 * operation is not applicable.
178 *
179 * @param Id the Id for the typecode for that the operations was attempted to
180 * perform.
181 */
182 static String not_applicable(String Id)
183 {
184 MARSHAL m = new MARSHAL("The read/write are not applicable for " + Id);
185 m.minor = Minor.Inappropriate;
186 throw m;
187 }
188 }