1 /* ValueBaseHelper.java --
2    Copyright (C) 2005, 2006 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.CDR.Vio;
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.ValueBase;
47 
48 import java.io.ObjectOutputStream;
49 import java.io.Serializable;
50 
51 /**
52  * A helper operations for the value base type ({@link ValueBase}).
53  *
54  * @since 1.3
55  *
56  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
57  */
58 public abstract class ValueBaseHelper
59 {
60   /**
61    * Extract the value type from the given Any.
62    *
63    * @param a the Any to extract from.
64    *
65    * @return the extracted value type.
66    */
extract(Any a)67   public static Serializable extract(Any a)
68   {
69     return a.extract_Value();
70   }
71 
72   /**
73    * Return the value base helper repository id.
74    *
75    * @return IDL:omg.org/CORBA/ValueBase:1.0, always.
76    */
id()77   public static String id()
78   {
79     return "IDL:omg.org/CORBA/ValueBase:1.0";
80   }
81 
82   /**
83    * Insert the value base that is Serializable into
84    * the given Any.
85    *
86    * @param a the Any to insert into.
87    * @param that the value base to insert.
88    */
insert(Any a, Serializable that)89   public static void insert(Any a, Serializable that)
90   {
91     a.insert_Value(that);
92   }
93 
94   /**
95    * Read the value base from the given input stream.
96    *
97    * @param input a stream to read from.
98    *
99    * @return the loaded value.
100    *
101    * @throws MARSHAL if the reading has failed due any reason.
102    */
read(InputStream input)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    */
type()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    */
write(OutputStream output, Serializable value)133   public static void write(OutputStream output, Serializable value)
134   {
135     Vio.write(output, value);
136   }
137 }
138