java::lang::CharSequence Class Reference

A CharSequence is a readable sequence of characters. More...

#include <java_lang_CharSequence.h>

Inheritance diagram for java::lang::CharSequence:

[legend]Collaboration diagram for java::lang::CharSequence:

[legend]List of all members.

Public Types
enum	{   xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9,   xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::java::lang::CharSequence >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::java::lang::CharSequence > >	array2D
Public Member Functions
virtual jchar	charAt (jint index,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the character at the specified index.
virtual jint	length (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the length of this character sequence.
virtual ::java::lang::CharSequence	subSequence (jint start, jint end,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a new character sequence that is a subsequence of this sequence.
virtual ::java::lang::String	toString (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a string containing the characters in this sequence in the same order as this sequence.

---

Detailed Description

A CharSequence is a readable sequence of characters.

This interface provides uniform, read-only access to many different kinds of character sequences.

This interface does not refine the general contracts of the equals and hashCode methods. The result of comparing two objects that implement CharSequence is therefore, in general, undefined. Each object may be implemented by a different class, and there is no guarantee that each class will be capable of testing its instances for equality with those of the other. It is therefore inappropriate to use arbitrary CharSequence instances as elements in a set or as keys in a map.

Author:

Mike McCloskey

---

Member Function Documentation

virtual jchar java::lang::CharSequence::charAt (  jint  index, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Returns the character at the specified index. An index ranges from zero to length() - 1. The first character of the sequence is at index zero, the next at index one, and so on, as for array indexing. Parameters: index  the index of the character to be returned p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the specified character Reimplemented in java::lang::StringBuffer.

virtual jint java::lang::CharSequence::length (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Returns the length of this character sequence. The length is the number of 16-bit Unicode characters in the sequence. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the number of characters in this sequence Reimplemented in java::lang::StringBuffer.

virtual ::java::lang::CharSequence java::lang::CharSequence::subSequence (  jint  start, jint  end, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns a new character sequence that is a subsequence of this sequence. The subsequence starts with the character at the specified index and ends with the character at index end - 1. The length of the returned sequence is end - start, so if start == end then an empty sequence is returned. Parameters: start  the start index, inclusive end  the end index, exclusive p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the specified subsequence

virtual ::java::lang::String java::lang::CharSequence::toString (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns a string containing the characters in this sequence in the same order as this sequence. The length of the string will be the length of this sequence. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: a string consisting of exactly this sequence of characters Reimplemented from java::lang::Object.

---

The documentation for this class was generated from the following file:

• java_lang_CharSequence.h

---