Frames | No Frames |
1: /* ObjectHolder.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; 40: 41: import gnu.CORBA.typecodes.PrimitiveTypeCode; 42: import gnu.CORBA.typecodes.RecordTypeCode; 43: 44: import org.omg.CORBA.portable.InputStream; 45: import org.omg.CORBA.portable.OutputStream; 46: import org.omg.CORBA.portable.Streamable; 47: 48: /** 49: * A holder for CORBA <code>Object</code> that is mapped into 50: * java <code>org.omg.CORBA.Object</code>. 51: * 52: * The holders have several application areas. The end user usually 53: * sees them implementing CORBA methods where the primitive type 54: * is passed by reference. While CORBA (or, for example, C) supports 55: * this, the java does not and a wrapper class is required. 56: * 57: * @author Audrius Meskauskas (AudriusA@Bioinformatics.org) 58: */ 59: public final class ObjectHolder 60: implements Streamable 61: { 62: /** 63: * The default type code for this holder if the object type code with 64: * the zero length string as id. 65: */ 66: private static final RecordTypeCode t_object; 67: 68: static 69: { 70: t_object = new RecordTypeCode(TCKind.tk_objref); 71: t_object.setId(""); 72: } 73: 74: /** 75: * The <code>org.omg.CORBA.Object</code> (CORBA <code>Object</code>) value, 76: * held by this ObjectHolder. 77: */ 78: public org.omg.CORBA.Object value; 79: 80: /** 81: * Constructs an instance of ObjectHolder, 82: * initializing {@link #value} to <code>0</code>. 83: */ 84: public ObjectHolder() 85: { 86: } 87: 88: /** 89: * Constructs an instance of ObjectHolder, 90: * initializing {@link #value} to the given <code>org.omg.CORBA.Object</code>. 91: * 92: * @param initial_value a value that will be assigned to the 93: * {@link #value} field. 94: */ 95: public ObjectHolder(org.omg.CORBA.Object initial_value) 96: { 97: value = initial_value; 98: } 99: 100: /** 101: * Fill in the {@link value } field by reading the required data 102: * from the given stream. For <code>org.omg.CORBA.Object</code>, the 103: * functionality is delegated to 104: * {@link org.omg.CORBA.portable.InputStream#read_Object}. 105: * 106: * @param input the input stream to read from. 107: */ 108: public void _read(InputStream input) 109: { 110: value = input.read_Object(); 111: } 112: 113: /** 114: * Returns the TypeCode, corresponding the CORBA type that is stored 115: * using this holder. 116: */ 117: public TypeCode _type() 118: { 119: return ObjectHelper.type(); 120: } 121: 122: /** 123: * Write the {@link value } field to the given stream. 124: * For <code>Object</code>, the functionality 125: * is delegated to 126: * {@link org.omg.CORBA.portable.OutputStream#write_Object(Object) }. 127: * 128: * @param output the output stream to write into. 129: */ 130: public void _write(OutputStream output) 131: { 132: output.write_Object(value); 133: }