001 /* ValueBaseHelper.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 package org.omg.CORBA; 040 041 import gnu.CORBA.CDR.Vio; 042 import gnu.CORBA.typecodes.RecordTypeCode; 043 044 import org.omg.CORBA.portable.InputStream; 045 import org.omg.CORBA.portable.OutputStream; 046 import org.omg.CORBA.portable.ValueBase; 047 048 import java.io.ObjectOutputStream; 049 import java.io.Serializable; 050 051 /** 052 * A helper operations for the value base type ({@link ValueBase}). 053 * 054 * @since 1.3 055 * 056 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org) 057 */ 058 public abstract class ValueBaseHelper 059 { 060 /** 061 * Extract the value type from the given Any. 062 * 063 * @param a the Any to extract from. 064 * 065 * @return the extracted value type. 066 */ 067 public static Serializable extract(Any a) 068 { 069 return a.extract_Value(); 070 } 071 072 /** 073 * Return the value base helper repository id. 074 * 075 * @return IDL:omg.org/CORBA/ValueBase:1.0, always. 076 */ 077 public static String id() 078 { 079 return "IDL:omg.org/CORBA/ValueBase:1.0"; 080 } 081 082 /** 083 * Insert the value base that is Serializable into 084 * the given Any. 085 * 086 * @param a the Any to insert into. 087 * @param that the value base to insert. 088 */ 089 public static void insert(Any a, Serializable that) 090 { 091 a.insert_Value(that); 092 } 093 094 /** 095 * Read the value base from the given input stream. 096 * 097 * @param input a stream to read from. 098 * 099 * @return the loaded value. 100 * 101 * @throws MARSHAL if the reading has failed due any reason. 102 */ 103 public static Serializable read(InputStream input) 104 { 105 return Vio.read(input); 106 } 107 108 /** 109 * Get the typecode of the value type. 110 * @return the typecode of the value type 111 */ 112 public static TypeCode type() 113 { 114 RecordTypeCode r = new RecordTypeCode(TCKind.tk_value); 115 return r; 116 } 117 118 /** 119 * Write the value base into the given stream. 120 * 121 * If the passed value implements the {@link CustomMarshal}, 122 * the helper uses {@link CustomMarshal#marshal} 123 * to write the content in a user defined way. Otherwise, 124 * this implementation initialises the {@link ObjectOutputStream} 125 * and writes through it. 126 * 127 * @param output a stream to write to. 128 * 129 * @param value a value to write. 130 * 131 * @throws MARSHAL if the writing failed due any reason. 132 */ 133 public static void write(OutputStream output, Serializable value) 134 { 135 Vio.write(output, value); 136 } 137 }