001/* DynEnumHelper.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 039 040package org.omg.DynamicAny; 041 042import gnu.CORBA.OrbRestricted; 043 044import org.omg.CORBA.BAD_OPERATION; 045import org.omg.CORBA.BAD_PARAM; 046import org.omg.CORBA.TypeCode; 047import org.omg.CORBA.Any; 048import org.omg.CORBA.portable.InputStream; 049import org.omg.CORBA.MARSHAL; 050import org.omg.CORBA.portable.OutputStream; 051 052/** 053 * The helper operations for {@link DynEnum}. Following the 1.5 JDK 054 * specifications, DynEnum is always a local object, so the two methods of this 055 * helper ({@link #read} and {@link #write} are not in use, always throwing 056 * {@link MARSHAL}. 057 * 058 * @specnote always throwing MARSHAL in read and write ensures compatibility 059 * with other popular implementations like Sun's. 060 * 061 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org) 062 */ 063public abstract class DynEnumHelper 064{ 065 /** 066 * Cast the passed object into the DynEnum. As DynEnum is a local object, the 067 * method just uses java type cast. 068 * 069 * @param obj the object to narrow. 070 * @return narrowed instance. 071 * @throws BAD_PARAM if the passed object is not a DynEnum. 072 */ 073 public static DynEnum narrow(org.omg.CORBA.Object obj) 074 { 075 try 076 { 077 return (DynEnum) obj; 078 } 079 catch (ClassCastException cex) 080 { 081 throw new BAD_PARAM(obj.getClass().getName() + " is not a DynEnum"); 082 } 083 } 084 085 /** 086 * Narrow the given object to the DynEnum. For the objects that are 087 * always local, this operation does not differ from the ordinary 088 * {@link #narrow} (ClassCastException will be thrown if narrowing something 089 * different). See OMG issue 4158. 090 * 091 * @param obj the object to cast. 092 * 093 * @return the casted DynEnum. 094 * 095 * @since 1.5 096 */ 097 public static DynEnum unchecked_narrow(org.omg.CORBA.Object obj) 098 { 099 return narrow(obj); 100 } 101 102 /** 103 * Get the type code of the {@link DynEnum}. 104 */ 105 public static TypeCode type() 106 { 107 return OrbRestricted.Singleton.create_interface_tc(id(), "DynEnum"); 108 } 109 110 /** 111 * Insert the DynEnum into the given Any. 112 * 113 * @param any the Any to insert into. 114 * 115 * @param that the DynEnum to insert. 116 */ 117 public static void insert(Any any, DynEnum that) 118 { 119 any.insert_Object(that); 120 } 121 122 /** 123 * Extract the DynEnum from given Any. 124 * 125 * @throws BAD_OPERATION if the passed Any does not contain DynEnum. 126 */ 127 public static DynEnum extract(Any any) 128 { 129 return narrow(any.extract_Object()); 130 } 131 132 /** 133 * Get the DynEnum repository id. 134 * 135 * @return "IDL:omg.org/DynamicAny/DynEnum:1.0", always. 136 */ 137 public static String id() 138 { 139 return "IDL:omg.org/DynamicAny/DynEnum:1.0"; 140 } 141 142 /** 143 * This should read DynEnum from the CDR input stream, but (following the JDK 144 * 1.5 API) it does not. 145 * 146 * @param input a org.omg.CORBA.portable stream to read from. 147 * 148 * @specenote Sun throws the same exception. 149 * 150 * @throws MARSHAL always. 151 */ 152 public static DynEnum read(InputStream input) 153 { 154 throw new MARSHAL(DynAnyFactoryHelper.not_applicable(id())); 155 } 156 157 /** 158 * This should read DynEnum from the CDR input stream, but (following the JDK 159 * 1.5 API) it does not. 160 * 161 * @param output a org.omg.CORBA.portable stream to write into. 162 * 163 * @specenote Sun throws the same exception. 164 * 165 * @throws MARSHAL always. 166 */ 167 public static void write(OutputStream output, DynEnum value) 168 { 169 throw new MARSHAL(DynAnyFactoryHelper.not_applicable(id())); 170 } 171}