org.jacorb.orb

Class CodeSet

java.lang.Object

org.jacorb.orb.CodeSet

public class CodeSet
extends Object

Author:

Gerald Brose

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CodeSet.InputBuffer This interface represents a buffer from which character data can be read.
static interface	CodeSet.OutputBuffer Represents a buffer to which character data may be written.

Constructor Summary

Constructors

Constructor and Description
CodeSet(int id, String name)

Method Summary

Methods

Modifier and Type	Method and Description
static String	csName(int cs) Convert the CORBA standard id to a String name.
int	get_wstring_size(String string, int startPos, int currentPos) Returns the length of the string just written to the buffer.
static CodeSet	getCodeSet(int id) Returns the code set which matches the specified ID.
static CodeSet	getCodeSet(String name) Returns the code set which matches the specified name, which should either be the canonical name of a supported encoding or the hex representation of its ID.
static CodeSet	getCodeSetIfMatched(int localCodeSetId, org.omg.CONV_FRAME.CodeSetComponent remote)
int	getId() Returns the CORBA-standard id for this code set.
static CodeSet	getMatchingCodeSet(org.omg.CONV_FRAME.CodeSetComponent local, org.omg.CONV_FRAME.CodeSetComponent remote, boolean wide)
String	getName() Returns the canonical name of this code set.
static CodeSet	getNegotiatedCodeSet(ORB orb, org.omg.CONV_FRAME.CodeSetComponentInfo serverCodeSetInfo, boolean wide)
char	read_wchar(CodeSet.InputBuffer buffer, int giop_minor, boolean littleEndian) Reads a wide character from the specified buffer.
String	read_wstring(CodeSet.InputBuffer buffer, int lengthIndicator, int giop_minor, boolean littleEndian) Reads a wide string from the buffer.
boolean	supportsCharacterData(boolean wide) Returns true if this codeset supports the specified character type.
boolean	supportsWideCharacterData() Returns true if this codeset supports multie-byte characters
String	toString()
boolean	write_bom(boolean configuredForBom) Returns true if this code set requires byte-order-markers to be written to the beginning of a stream of text.
void	write_char(CodeSet.OutputBuffer buffer, char c, boolean write_bom, boolean write_length, int giop_minor) Writes a character to the buffer with the appropriate encoding.
void	write_string(CodeSet.OutputBuffer buffer, String s, boolean write_bom, boolean write_length, int giop_minor) Writes a sting to the buffer with the appropriate encoding.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CodeSet

public CodeSet(int id,
       String name)

Method Detail

csName

public static String csName(int cs)

Convert the CORBA standard id to a String name.

Parameters:

cs -

Returns:

getCodeSet

public static CodeSet getCodeSet(String name)

Returns the code set which matches the specified name, which should either be the canonical name of a supported encoding or the hex representation of its ID.

Parameters:

name - the string used to select a codeset.

Returns:

the matching code set or NULL_CODE_SET if there are no matches.

getCodeSet

public static CodeSet getCodeSet(int id)

Returns the code set which matches the specified ID.

Returns:

the matching code set or NULL_CODE_SET if there are no matches.

getNegotiatedCodeSet

public static CodeSet getNegotiatedCodeSet(ORB orb,
                           org.omg.CONV_FRAME.CodeSetComponentInfo serverCodeSetInfo,
                           boolean wide)

getMatchingCodeSet

public static CodeSet getMatchingCodeSet(org.omg.CONV_FRAME.CodeSetComponent local,
                         org.omg.CONV_FRAME.CodeSetComponent remote,
                         boolean wide)

getCodeSetIfMatched

public static CodeSet getCodeSetIfMatched(int localCodeSetId,
                          org.omg.CONV_FRAME.CodeSetComponent remote)

supportsCharacterData

public boolean supportsCharacterData(boolean wide)

Returns true if this codeset supports the specified character type.

Parameters:

wide -

supportsWideCharacterData

public boolean supportsWideCharacterData()

Returns true if this codeset supports multie-byte characters

getId

public int getId()

Returns the CORBA-standard id for this code set.

getName

public String getName()

Returns the canonical name of this code set.

toString

public String toString()

Overrides:

toString in class Object

write_bom

public boolean write_bom(boolean configuredForBom)

Returns true if this code set requires byte-order-markers to be written to the beginning of a stream of text.

Parameters:

configuredForBom - true if the orb has been configured to write byte-order-markers.

read_wchar

public char read_wchar(CodeSet.InputBuffer buffer,
              int giop_minor,
              boolean littleEndian)

Reads a wide character from the specified buffer.

Parameters:

buffer - the buffer containing the data.

giop_minor - the low-order byte of the giop version (1.x is assumed)

littleEndian - true if the character is to be read low end first

Returns:

the wide character.

read_wstring

public String read_wstring(CodeSet.InputBuffer buffer,
                  int lengthIndicator,
                  int giop_minor,
                  boolean littleEndian)

Reads a wide string from the buffer. The length indicator is presumed already to have been read.

Parameters:

buffer - the buffer from which to read the string

lengthIndicator - the length indicator already read

giop_minor - the low-order byte of the giop version (1.x is assumed)

littleEndian - true if the characters are to be read low end first

Returns:

a string possibly containing wide characters.

write_char

public void write_char(CodeSet.OutputBuffer buffer,
              char c,
              boolean write_bom,
              boolean write_length,
              int giop_minor)

Writes a character to the buffer with the appropriate encoding.

Parameters:

buffer - the buffer to which the character is written

c - the character to write

write_bom - true if a byte-order-marker (indicating big-endian) should be written

write_length - true if the length of the character should be written

giop_minor - the low-order byte of the giop version (1.x is assumed)

write_string

public void write_string(CodeSet.OutputBuffer buffer,
                String s,
                boolean write_bom,
                boolean write_length,
                int giop_minor)

Writes a sting to the buffer with the appropriate encoding.

Parameters:

buffer - the buffer to which the string is written

s - the string to write

write_bom - true if a byte-order-marker (indicating big-endian) should be written

write_length - true if the length of the character should be written

giop_minor - the low-order byte of the giop version (1.x is assumed)

get_wstring_size

public int get_wstring_size(String string,
                   int startPos,
                   int currentPos)

Returns the length of the string just written to the buffer.

Parameters:

string - the string written

startPos - the starting position at which the string was written

currentPos - the current buffer position