001 /* FieldNameHelper.java --
002 Copyright (C) 2005 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.DynamicAny;
040
041 import gnu.CORBA.OrbRestricted;
042
043 import org.omg.CORBA.Any;
044 import org.omg.CORBA.ORB;
045 import org.omg.CORBA.TypeCode;
046 import org.omg.CORBA.portable.InputStream;
047 import org.omg.CORBA.portable.OutputStream;
048
049 /**
050 * A helper for the FieldName. The fields {@link NameValuePair#id},
051 * {@link NameDynAnyPair#id} and return values of methods
052 * <code>current_member_name()</code>, <code>member_name()</code> in several
053 * interfaces officially have the "FieldName" type. This type is directly
054 * mapped into java String and needs no helper. The helper
055 * is included only as a part of the formal standard.
056 *
057 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
058 */
059 public abstract class FieldNameHelper
060 {
061 /**
062 * Insert the FieldName into Any (uses {@link Any#insert_string}).
063 *
064 * @param a the Any to insert into.
065 * @param that the string to insert.
066 */
067 public static void insert(Any a, String that)
068 {
069 a.insert_string(that);
070 }
071
072 /**
073 * Extract the FieldName from Any ((uses {@link Any#extract_string}).
074 *
075 * @param a the Any to extract from.
076 */
077 public static String extract(Any a)
078 {
079 return a.extract_string();
080 }
081
082 /**
083 * Return an alias typecode.
084 */
085 public static TypeCode type()
086 {
087 ORB orb = OrbRestricted.Singleton;
088 return orb.create_alias_tc(id(), "FieldName", orb.create_string_tc(0));
089 }
090
091 /**
092 * Return the FieldName repository id.
093 * @return "IDL:omg.org/DynamicAny/FieldName:1.0", always.
094 */
095 public static String id()
096 {
097 return "IDL:omg.org/DynamicAny/FieldName:1.0";
098 }
099
100 /**
101 * Calls {@link InputStream#read_string()}.
102 *
103 * @param istream the stream to read from.
104 */
105 public static String read(InputStream istream)
106 {
107 return istream.read_string();
108 }
109
110 /**
111 * Calls {@link OutputStream#write_string(String)}.
112 *
113 * @param ostream the stream to write into.
114 * @param value the string (FieldName) value to write.
115 */
116 public static void write(OutputStream ostream, String value)
117 {
118 ostream.write_string(value);
119 }
120 }