001/* AdapterNameHelper.java -- 002 Copyright (C) 2005 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package org.omg.PortableInterceptor; 040 041import gnu.CORBA.OrbRestricted; 042 043import org.omg.CORBA.Any; 044import org.omg.CORBA.ORB; 045import org.omg.CORBA.StringSeqHelper; 046import org.omg.CORBA.StringSeqHolder; 047import org.omg.CORBA.TypeCode; 048import org.omg.CORBA.portable.InputStream; 049import org.omg.CORBA.portable.OutputStream; 050 051/** 052 * Provides static helper methods for working with the adapter name helper. 053 * The adapter name helper is an array of strings, so {@link StringSeqHelper} 054 * could be used for io operations. The separate helper is provided anyway. 055 * 056 * @since 1.5 057 * 058 * @author Audrius Meskauskas (AudriusA@Bioinformatics.org) 059 */ 060public abstract class AdapterNameHelper 061{ 062 063 /** 064 * Extract the adapter name (<code>String[]</code>) from the given {@link Any}. 065 * 066 * @param a an Any to extract the array from. 067 * 068 * @return the extracted array. 069 */ 070 public static String[] extract(Any a) 071 { 072 StringSeqHolder h = (StringSeqHolder) a.extract_Streamable(); 073 return h.value; 074 } 075 076 /** 077 * Returns the agreed Id. 078 * 079 * @return "IDL:omg.org/PortableInterceptor/AdapterName:1.0", always. 080 */ 081 public static String id() 082 { 083 return "IDL:omg.org/PortableInterceptor/AdapterName:1.0"; 084 } 085 086 /** 087 * Insert into the given adapter name (<code>String[]</code>) into the 088 * given {@link Any}. 089 * 090 * @param into the target Any. 091 * @param that the array to insert. 092 */ 093 public static void insert(Any into, String[] that) 094 { 095 StringSeqHolder holder = new StringSeqHolder(that); 096 into.insert_Streamable(holder); 097 into.type(type()); 098 } 099 100 /** 101 * Reads the <code>String[]</code> from the CORBA input stream. 102 * 103 * @param input the CORBA stream to read from. 104 * @return the value from the stream. 105 */ 106 public static String[] read(InputStream input) 107 { 108 return StringSeqHelper.read(input); 109 } 110 111 /** 112 * Creates and returns a new instance of the TypeCode, corresponding the 113 * adapter name. 114 * 115 * @return the alias of the string sequence, named "AdapterName". 116 */ 117 public static TypeCode type() 118 { 119 ORB orb = OrbRestricted.Singleton; 120 121 TypeCode component = orb.create_string_tc(0); 122 return orb.create_alias_tc(id(), "AdapterName", component); 123 } 124 125 /** 126 * Writes the <code>String[]</code> into the given stream. 127 * 128 * @param output the CORBA output stream to write. 129 * @param value the value that must be written. 130 */ 131 public static void write(OutputStream output, String[] value) 132 { 133 StringSeqHelper.write(output, value); 134 } 135}