Oracle

weblogic.wtc.jatmi
Class TypedString

java.lang.Object
  extended by weblogic.wtc.jatmi.StandardTypes
      extended by weblogic.wtc.jatmi.TypedString
All Implemented Interfaces:
Serializable, TypedBuffer

public final class TypedString
extends StandardTypes
implements TypedBuffer, Serializable

This is the jatmi analogue to the STRING Tuxedo buffer type

See Also:
StandardTypes, TypedBuffer, Serialized Form

Field Summary
 
Fields inherited from class weblogic.wtc.jatmi.StandardTypes
CALLOUT_HINT, CARRAY_HINT, CMPS_HDR_HINT, COMPOS_HINT, FML_HINT, FML32_HINT, MBSTRING_HINT, MTTYP_HINT, PROP_HINT, ROUTE_HINT, RPCRP_HINT, RPCRQ_HINT, STRING_HINT, TDOM_VALS_HINT, TGIOP_HINT, TM_HINT, TPINITTYPE_HINT, TRAN_HINT, UNSOL_HINT, VIEW_HINT, VIEW32_HINT, WS_HINT, WSRPCRQ_HINT, X_C_TYPE_HINT, X_COMMON_HINT, X_OCTET_HINT, XML_HINT
 
Constructor Summary
TypedString()
          Generates a StringBuffer with the default capacity of 16
TypedString(int capacity)
          Creates an empty StringBuffer that has the initial capacity given
TypedString(String str)
          Constructor.
 
Method Summary
 void _tmpostrecv(DataInputStream decoder, int recv_size)
          XDR decodes the given string.
 void _tmpresend(DataOutputStream encoder)
          This function presends and encodes the given TypedBuffer object.
 StringBuffer getStringBuffer()
          Gets the StringBuffer associated with this object.
 String toString()
          Returns a copy of this object as a String
 
Methods inherited from class weblogic.wtc.jatmi.StandardTypes
getHintIndex, getSubtype, getType, hint_to_type
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface weblogic.wtc.jatmi.TypedBuffer
getHintIndex, getSubtype, getType
 

Constructor Detail

TypedString

public TypedString()
Generates a StringBuffer with the default capacity of 16


TypedString

public TypedString(int capacity)
Creates an empty StringBuffer that has the initial capacity given

Parameters:
capacity - The capacity the StringBuffer associated with this TypedString should have

TypedString

public TypedString(String str)
Constructor. Initializes object with a copy of the input string

Parameters:
str - the string to initialize this object with
Method Detail

getStringBuffer

public StringBuffer getStringBuffer()
Gets the StringBuffer associated with this object. Note that the object returned is the same object store used by this object, so care should be taken when updating the object returned while this TypedString is used in another thread. Use the toString method on this object to return this object as a String.

Returns:
The StringBuffer associated with this TypedString

_tmpresend

public void _tmpresend(DataOutputStream encoder)
                throws TPException,
                       IOException
This function presends and encodes the given TypedBuffer object. It is equivalent to the combination of _tmpresend and _tmencdec functions from the buffer(3i) TUXEDO manual page.

XDR encodes the given string. XDR encoding of a string is four length bytes (not including any NULL byte at the end) followed by the string itself (low 32 bits of the unicode characters). It is padded out to make the total length a multiple of four.

Specified by:
_tmpresend in interface TypedBuffer
Parameters:
encoder - The output stream to encode this type to. Should not be padded.
Throws:
TPException -
  • TPEINVAL - If there was some problem with the state of the TypedBuffer.
  • Any other errno is considered a fatal error
IOException - If there was an error writing to the DataOutputStream

_tmpostrecv

public void _tmpostrecv(DataInputStream decoder,
                        int recv_size)
                 throws TPException,
                        IOException
XDR decodes the given string. XDR encoding of a string is four length bytes (not including any NULL byte at the end) followed by the string itself (low 32 bits of the unicode characters). It is padded out to make the total length a multiple of four.

Specified by:
_tmpostrecv in interface TypedBuffer
Parameters:
decoder - A stream that starts with the encoded data for this buffer type. Only recv_size bytes should be read from the stream (though at the time this function is called all bytes necessary to decode this type should be available)
recv_size - The total size of encoded data from the start position (note that encoded may be larger than the actual recieved size)
Throws:
TPException - TPEINVAL if this stream could not be decoded for any reason
IOException - if there was an error reading from the stream

toString

public String toString()
Returns a copy of this object as a String

Overrides:
toString in class Object

Documentation is available at
http://download.oracle.com/docs/cd/E12839_01/web.1111
Copyright 1996,2009, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Part Number E13941-01
Oracle WebLogic Server 10.3.1 API Reference