gnu.CORBA

Class WStringHolder

Implemented Interfaces:
Streamable

public class WStringHolder
extends Object
implements Streamable

A holder for CORBA wstring that is mapped into java String. This holder writes and reads differently from the StringHolder. The holders have several application areas. The end user usually sees them implementing CORBA methods where the primitive type is passed by reference. While CORBA (or, for example, C) supports this, the java does not and a wrapper class is required.

Field Summary

String
value
The String (CORBA string) value, held by this WStringHolder.

Constructor Summary

WStringHolder()
Constructs an instance of WStringHolder, initializing value to null.
WStringHolder(String initial_value)
Constructs an instance of WStringHolder, initializing value to the given String.

Method Summary

void
_read(InputStream input)
Fill in the value field by reading the required data from the given stream.
TypeCode
_type()
Returns the TypeCode, corresponding the CORBA type that is stored using this holder.
void
_write(OutputStream output)
Write the value field to the given stream.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

value

public String value
The String (CORBA string) value, held by this WStringHolder.

Constructor Details

WStringHolder

public WStringHolder()
Constructs an instance of WStringHolder, initializing value to null.

WStringHolder

public WStringHolder(String initial_value)
Constructs an instance of WStringHolder, initializing value to the given String.
Parameters:
initial_value - a value that will be assigned to the value field.

Method Details

_read

public void _read(InputStream input)
Fill in the value field by reading the required data from the given stream. For string, the functionality is delegated to InputStream.read_wstring().
Specified by:
_read in interface Streamable
Parameters:
input - the input stream to read from.

_type

public TypeCode _type()
Returns the TypeCode, corresponding the CORBA type that is stored using this holder. The TypeCode.length() method of the returned typecode always returns 0.
Specified by:
_type in interface Streamable

_write

public void _write(OutputStream output)
Write the value field to the given stream. For string, the functionality is delegated to OutputStream.write_wstring(String).
Specified by:
_write in interface Streamable
Parameters:
output - the output stream to write into.

WStringHolder.java -- Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.