GNU Classpath (0.17) | ||
Frames | No Frames |
1: /* InputStream.java -- 2: Copyright (C) 2005 Free Software Foundation, Inc. 3: 4: This file is part of GNU Classpath. 5: 6: GNU Classpath is free software; you can redistribute it and/or modify 7: it under the terms of the GNU General Public License as published by 8: the Free Software Foundation; either version 2, or (at your option) 9: any later version. 10: 11: GNU Classpath is distributed in the hope that it will be useful, but 12: WITHOUT ANY WARRANTY; without even the implied warranty of 13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14: General Public License for more details. 15: 16: You should have received a copy of the GNU General Public License 17: along with GNU Classpath; see the file COPYING. If not, write to the 18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19: 02110-1301 USA. 20: 21: Linking this library statically or dynamically with other modules is 22: making a combined work based on this library. Thus, the terms and 23: conditions of the GNU General Public License cover the whole 24: combination. 25: 26: As a special exception, the copyright holders of this library give you 27: permission to link this library with independent modules to produce an 28: executable, regardless of the license terms of these independent 29: modules, and to copy and distribute the resulting executable under 30: terms of your choice, provided that you also meet, for each linked 31: independent module, the terms and conditions of the license of that 32: module. An independent module is a module which is not derived from 33: or based on this library. If you modify this library, you may extend 34: this exception to your version of the library, but you are not 35: obligated to do so. If you do not wish to do so, delete this 36: exception statement from your version. */ 37: 38: 39: package org.omg.CORBA_2_3.portable; 40: 41: import gnu.CORBA.CDR.Vio; 42: 43: import org.omg.CORBA.portable.BoxedValueHelper; 44: 45: import java.io.Serializable; 46: 47: /** 48: * This class defines a new CDR input stream methods, added since 49: * CORBA 2.3. 50: * 51: * This class is abstract; no direct instances can be instantiated. 52: * Also, up till v 1.4 inclusive there are no methods that would 53: * return it, and only one unimplemented interface, 54: * {@link org.omg.CORBA.portable.ValueFactory }, needs it as a parameter. 55: * 56: * However since 1.3 all methods, declared as returning an 57: * org.omg.CORBA.portable.InputStream actually return the instance of this 58: * derived class and the new methods are accessible after the casting 59: * operation. 60: * 61: * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org) 62: */ 63: public abstract class InputStream 64: extends org.omg.CORBA.portable.InputStream 65: { 66: /** 67: * Read the abstract interface. An abstract interface can be either 68: * CORBA value type or CORBA object and is returned as an abstract 69: * java.lang.Object. 70: * 71: * As specified in OMG specification, this reads a single 72: * boolean and then delegates either to {@link #read_Object()} (for false) 73: * or to {@link #read_Value()} (for true). 74: * 75: * @return an abstract interface, unmarshaled from the stream. 76: */ 77: public Object read_abstract_interface() 78: { 79: boolean isValue = read_boolean(); 80: 81: if (isValue) 82: return read_value(); 83: else 84: return read_Object(); 85: } 86: 87: /** 88: * Read the abstract interface, corresponding to the passed type. 89: * An abstract interface can be either CORBA value type or CORBA 90: * object and is returned as an abstract java.lang.Object. 91: * 92: * As specified in OMG specification, this reads a single 93: * boolean and then delegates either to {@link #read_Object(Class)} (for false) 94: * or to {@link #read_Value(Class)} (for true). 95: * 96: * @param clz a base class for the abstract interface. 97: * 98: * @return an abstract interface, unmarshaled from the stream 99: */ 100: public Object read_abstract_interface(Class clz) 101: { 102: boolean isValue = read_boolean(); 103: 104: if (isValue) 105: return read_value(clz); 106: else 107: return read_Object(clz); 108: } 109: 110: /** 111: * Read a value type structure, extracting the repository id 112: * from the input stream itself. The repository id is optional 113: * in the value type record, but it must be present for this 114: * method to succeed. The {@link OutputStream} of this 115: * implementation always stores the repository id. 116: * 117: * The casts the streams ORB into a CORBA 2.3 ORB and then 118: * searched for a suitable value factory, where it delegates 119: * the functionality. 120: * 121: * If you know the exact class or can create an unitialised instance 122: * of the value type, it is recommended (faster) to use 123: * {@link #read_value(Class)} or {@link #read_value(Serializable)} 124: * instead. 125: * 126: * @param repository_id a repository id of the value type. 127: * 128: * @return an value type structure, unmarshaled from the stream 129: */ 130: public Serializable read_value() 131: { 132: return Vio.read(this); 133: } 134: 135: /** 136: * Read a value type structure, corresponing to the passed type. 137: * As the type is known, the repository Id in the input stream is 138: * optional an not required. The codebase, if present, is also ignored. 139: * 140: * The passed class must implement either {@link CustomMarshal} 141: * for the user-defined reading operations or {@link StreamableValue} 142: * for the standard (generated by IDL compiler) reading operations. 143: * Also, it must have the parameterless constructor to create a new 144: * instance. 145: * 146: * @param clz a base class for a value type. 147: * 148: * @return an value type structure, unmarshaled from the stream 149: */ 150: public Serializable read_value(Class clz) 151: { 152: return Vio.read(this, clz); 153: } 154: 155: /** 156: * Read a value type structure content, when the unitialised 157: * instance is passed as a parameter. It is a fastest method to read 158: * a value type. 159: * 160: * As the type is known, the repository Id in the input stream is 161: * optional an not required. The codebase, if present, is also ignored. 162: * 163: * The passed instance must implement either {@link CustomMarshal} 164: * for the user-defined reading operations or {@link StreamableValue} 165: * for the standard (generated by IDL compiler) reading operations. 166: * 167: * @param unitialised_value the unitialised value. 168: * 169: * @return same value, filled in by the stream content. 170: */ 171: public Serializable read_value(Serializable unitialised_value) 172: { 173: return Vio.read(this, unitialised_value); 174: } 175: 176: /** 177: * Read a value type structure, having the given repository id. 178: * The casts the streams ORB into a CORBA 2.3 ORB and then 179: * searched for a suitable value factory, where it delegates 180: * the functionality. 181: * 182: * If you know the exact class or can create an unitialised instance 183: * of the value type, it is recommended (faster) to use 184: * {@link #read_value(Class)} or {@link #read_value(Serializable)} 185: * instead. 186: * 187: * @param repository_id a repository id of the value type. 188: * 189: * @return an value type structure, unmarshaled from the stream 190: */ 191: public Serializable read_value(String repository_id) 192: { 193: return ((org.omg.CORBA_2_3.ORB) orb()).lookup_value_factory(repository_id) 194: .read_value(this); 195: } 196: 197: /** 198: * Use the provided boxed value helper to read the value. 199: * 200: * @param helper a helper for reading the value from the stream. 201: * 202: * @return an value type structure, unmarshaled from the stream. 203: */ 204: public Serializable read_value(BoxedValueHelper helper) 205: { 206: return helper.read_value(this); 207: }
GNU Classpath (0.17) |