com.ibm.diameter.packet
Class AvpValueUtilUTF8String

java.lang.Object
  extended by com.ibm.diameter.packet.AvpValueUtil
      extended by com.ibm.diameter.packet.AvpValueUtilUTF8String

public class AvpValueUtilUTF8String
extends AvpValueUtil

Class used to hold a string Value of AVPs of type UTF8String. Note that the interface is intended to allow the simple use of the java.lang.String class. Conversion of this class to UTF8String characters is done automatically by this class when transmitting or receiving an AVP that holds a UTF-8 String.


Constructor Summary
AvpValueUtilUTF8String()
          Creates an uninitialized instance of AvpValueUtilUTF8String.
AvpValueUtilUTF8String(java.lang.String value)
          Creates an initialized instance of AvpValueUtilUTF8String using a String variable as the argument.
 
Method Summary
 java.lang.String getAvpValue()
          Gets the String value of this AvpValueUtilUTF8String.
 java.lang.Object getValue()
          Returns the AVP data.
 void getValueFromByteArray(byte[] in, int offset, int valueLength)
          Populates the AVP data field by reading the appropriate number of bytes from the supplied byte[]
 void getValueFromByteBuffer(com.ibm.wsspi.buffermgmt.WsByteBuffer in, int valueLength)
          Populates the AVP data field by reading the appropriate number of bytes from the WsByteBuffer
 void getValueFromByteBufferStream(com.ibm.diameter.util.DiamWsByteBufferInputStream in, int valueLength)
          Populates the AVP data field by reading the appropriate number of bytes from the supplied DiamWsByteBufferInputStream
 void getValueFromStream(java.io.DataInputStream in, int valueLength)
          Populates the AVP data field by reading the appropriate number of bytes from the DataInputStream
 int getValueLength()
          Returns the length of the AVP data field in octets.
 void setAvpValue(java.lang.String value)
          Sets the String value in this object.
 void writeValueToByteBufferStream(com.ibm.diameter.util.DiamWsByteBufferOutputStream out)
          Writes the AVP data field to the DiamWsByteBufferInputStream
 void writeValueToStream(java.io.DataOutputStream out)
          Writes the AVP data field to the DataOutputStream
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AvpValueUtilUTF8String

public AvpValueUtilUTF8String()
Creates an uninitialized instance of AvpValueUtilUTF8String.


AvpValueUtilUTF8String

public AvpValueUtilUTF8String(java.lang.String value)
Creates an initialized instance of AvpValueUtilUTF8String using a String variable as the argument. Note that the user of this class is expected to pass a simple java.lang.String variable. Internally, this is held as a UTF-16 set of characters. However, when it is transmitted as part of an AVP in a Diameter message, it will be converted to a UTF-8 String format.

Method Detail

getValueFromByteBuffer

public void getValueFromByteBuffer(com.ibm.wsspi.buffermgmt.WsByteBuffer in,
                                   int valueLength)
                            throws java.io.IOException,
                                   java.io.EOFException,
                                   java.io.UnsupportedEncodingException
Description copied from class: AvpValueUtil
Populates the AVP data field by reading the appropriate number of bytes from the WsByteBuffer

Overrides:
getValueFromByteBuffer in class AvpValueUtil
Parameters:
in - The WsByteBuffer that contains the AVP data.
valueLength - The number of bytes to read from the WsByteBuffer
Throws:
com.ibm.diameter.packet.exception.DataOutOfSyncException
java.io.IOException
java.io.EOFException
java.io.UnsupportedEncodingException

getValueFromByteArray

public void getValueFromByteArray(byte[] in,
                                  int offset,
                                  int valueLength)
                           throws java.io.IOException,
                                  java.io.EOFException,
                                  java.io.UnsupportedEncodingException
Description copied from class: AvpValueUtil
Populates the AVP data field by reading the appropriate number of bytes from the supplied byte[]

Overrides:
getValueFromByteArray in class AvpValueUtil
Parameters:
in - The byte[] that contains the AVP data.
offset - The position in the byte[] to be begin reading at
valueLength - The number of bytes to read from the byte[]
Throws:
com.ibm.diameter.packet.exception.DataOutOfSyncException
java.io.IOException
java.io.EOFException
java.io.UnsupportedEncodingException

getValueFromByteBufferStream

public void getValueFromByteBufferStream(com.ibm.diameter.util.DiamWsByteBufferInputStream in,
                                         int valueLength)
                                  throws java.io.IOException,
                                         java.io.EOFException
Description copied from class: AvpValueUtil
Populates the AVP data field by reading the appropriate number of bytes from the supplied DiamWsByteBufferInputStream

Overrides:
getValueFromByteBufferStream in class AvpValueUtil
Parameters:
in - The DiamWsByteBufferInputStream that contains the AVP data.
valueLength - The number of bytes to read from the DiamWsByteBufferInputStream
Throws:
com.ibm.diameter.packet.exception.DataOutOfSyncException
java.io.IOException
java.io.EOFException

writeValueToByteBufferStream

public void writeValueToByteBufferStream(com.ibm.diameter.util.DiamWsByteBufferOutputStream out)
                                  throws java.io.IOException
Description copied from class: AvpValueUtil
Writes the AVP data field to the DiamWsByteBufferInputStream

Overrides:
writeValueToByteBufferStream in class AvpValueUtil
Parameters:
out - The DiamWsByteBufferInputStream to write to
Throws:
java.io.IOException

getValueFromStream

public void getValueFromStream(java.io.DataInputStream in,
                               int valueLength)
                        throws java.io.IOException,
                               java.io.EOFException
Description copied from class: AvpValueUtil
Populates the AVP data field by reading the appropriate number of bytes from the DataInputStream

Overrides:
getValueFromStream in class AvpValueUtil
Parameters:
in - The DataInputStream that contains the AVP data.
valueLength - The number of bytes to read from the DataInputStream
Throws:
com.ibm.diameter.packet.exception.DataOutOfSyncException
java.io.IOException
java.io.EOFException

writeValueToStream

public void writeValueToStream(java.io.DataOutputStream out)
                        throws java.io.IOException
Description copied from class: AvpValueUtil
Writes the AVP data field to the DataOutputStream

Overrides:
writeValueToStream in class AvpValueUtil
Parameters:
out - The DataOutputStream to write to
Throws:
java.io.IOException

getValueLength

public int getValueLength()
Description copied from class: AvpValueUtil
Returns the length of the AVP data field in octets. Note that the length does not include any of the AVP header fields. It only applies to the length of the Avp data.

Overrides:
getValueLength in class AvpValueUtil
Returns:
length of the AVP data field

getValue

public java.lang.Object getValue()
Description copied from class: AvpValueUtil
Returns the AVP data.

Overrides:
getValue in class AvpValueUtil
Returns:
The AVP data. This must be cast to the appropriate data type.

getAvpValue

public java.lang.String getAvpValue()
Gets the String value of this AvpValueUtilUTF8String.

Returns:
String value held by this object.

setAvpValue

public void setAvpValue(java.lang.String value)
Sets the String value in this object.

Parameters:
value - String to be sent as a UTF-8 String in a Diameter message.


Copyright © 2006 IBM Corp. All Rights Reserved.