Main Page | Modules | Class Hierarchy | Class List | Directories | File List | Class Members | Related Pages

java::lang::Character Class Reference

The Character class wraps a value of the primitive type char in an object. More...

#include <java_lang_Character.h>

Inheritance diagram for java::lang::Character:

Inheritance graph
[legend]
Collaboration diagram for java::lang::Character:

Collaboration graph
[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::Character
array1D
typedef ::xmog_java_array_template<
::xmog_java_array_template<
::java::lang::Character > > 
array2D

Public Member Functions

 Character (jchar value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Constructs a newly allocated Character object that represents the specified char value.
jchar charValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns the value of this Character object.
jint compareTo (const ::java::lang::Character &anotherCharacter,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Compares two Character objects numerically.
jint compareTo (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Compares this Character object to another object.
bool equals (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Compares this object against the specified object.
jint hashCode (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns a hash code for this Character.
::java::lang::String toString (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns a String object representing this Character's value.

Static Public Member Functions

static jint digit (jchar ch, jint radix,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns the numeric value of the character ch in the specified radix.
static jchar forDigit (jint digit, jint radix,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines the character representation for a specific digit in the specified radix.
static jbyte getDirectionality (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns the Unicode directionality property for the given character.
static jint getNumericValue (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns the int value that the specified Unicode character represents.
static jint getType (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns a value indicating a character's general category.
static bool isDefined (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if a character is defined in Unicode.
static bool isDigit (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if the specified character is a digit.
static bool isIdentifierIgnorable (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if the specified character should be regarded as an ignorable character in a Java identifier or a Unicode identifier.
static bool isISOControl (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if the specified character is an ISO control character.
static bool isJavaIdentifierPart (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if the specified character may be part of a Java identifier as other than the first character.
static bool isJavaIdentifierStart (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if the specified character is permissible as the first character in a Java identifier.
static bool isJavaLetter (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if the specified character is permissible as the first character in a Java identifier.
static bool isJavaLetterOrDigit (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if the specified character may be part of a Java identifier as other than the first character.
static bool isLetter (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if the specified character is a letter.
static bool isLetterOrDigit (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if the specified character is a letter or digit.
static bool isLowerCase (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if the specified character is a lowercase character.
static bool isMirrored (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines whether the character is mirrored according to the Unicode specification.
static bool isSpace (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if the specified character is ISO-LATIN-1 white space.
static bool isSpaceChar (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if the specified character is a Unicode space character.
static bool isTitleCase (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if the specified character is a titlecase character.
static bool isUnicodeIdentifierPart (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if the specified character may be part of a Unicode identifier as other than the first character.
static bool isUnicodeIdentifierStart (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if the specified character is permissible as the first character in a Unicode identifier.
static bool isUpperCase (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if the specified character is an uppercase character.
static bool isWhitespace (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Determines if the specified character is white space according to Java.
static jchar toLowerCase (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Converts the character argument to lowercase using case mapping information from the UnicodeData file.
::java::lang::String toString (jchar c,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Returns a String object representing the specified char.
static jchar toTitleCase (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Converts the character argument to titlecase using case mapping information from the UnicodeData file.
static jchar toUpperCase (jchar ch,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Converts the character argument to uppercase using case mapping information from the UnicodeData file.

Static Public Attributes

static xmog_byte COMBINING_SPACING_MARK
 General category "Mc" in the Unicode specification.
static xmog_byte CONNECTOR_PUNCTUATION
 General category "Pc" in the Unicode specification.
static xmog_byte CONTROL
 General category "Cc" in the Unicode specification.
static xmog_byte CURRENCY_SYMBOL
 General category "Sc" in the Unicode specification.
static xmog_byte DASH_PUNCTUATION
 General category "Pd" in the Unicode specification.
static xmog_byte DECIMAL_DIGIT_NUMBER
 General category "Nd" in the Unicode specification.
static xmog_byte DIRECTIONALITY_ARABIC_NUMBER
 Weak bidirectional character type "AN" in the Unicode specification.
static xmog_byte DIRECTIONALITY_BOUNDARY_NEUTRAL
 Weak bidirectional character type "BN" in the Unicode specification.
static xmog_byte DIRECTIONALITY_COMMON_NUMBER_SEPARATOR
 Weak bidirectional character type "CS" in the Unicode specification.
static xmog_byte DIRECTIONALITY_EUROPEAN_NUMBER
 Weak bidirectional character type "EN" in the Unicode specification.
static xmog_byte DIRECTIONALITY_EUROPEAN_NUMBER_SEPARATOR
 Weak bidirectional character type "ES" in the Unicode specification.
static xmog_byte DIRECTIONALITY_EUROPEAN_NUMBER_TERMINATOR
 Weak bidirectional character type "ET" in the Unicode specification.
static xmog_byte DIRECTIONALITY_LEFT_TO_RIGHT
 Strong bidirectional character type "L" in the Unicode specification.
static xmog_byte DIRECTIONALITY_LEFT_TO_RIGHT_EMBEDDING
 Strong bidirectional character type "LRE" in the Unicode specification.
static xmog_byte DIRECTIONALITY_LEFT_TO_RIGHT_OVERRIDE
 Strong bidirectional character type "LRO" in the Unicode specification.
static xmog_byte DIRECTIONALITY_NONSPACING_MARK
 Weak bidirectional character type "NSM" in the Unicode specification.
static xmog_byte DIRECTIONALITY_OTHER_NEUTRALS
 Neutral bidirectional character type "ON" in the Unicode specification.
static xmog_byte DIRECTIONALITY_PARAGRAPH_SEPARATOR
 Neutral bidirectional character type "B" in the Unicode specification.
static xmog_byte DIRECTIONALITY_POP_DIRECTIONAL_FORMAT
 Weak bidirectional character type "PDF" in the Unicode specification.
static xmog_byte DIRECTIONALITY_RIGHT_TO_LEFT
 Strong bidirectional character type "R" in the Unicode specification.
static xmog_byte DIRECTIONALITY_RIGHT_TO_LEFT_ARABIC
 Strong bidirectional character type "AL" in the Unicode specification.
static xmog_byte DIRECTIONALITY_RIGHT_TO_LEFT_EMBEDDING
 Strong bidirectional character type "RLE" in the Unicode specification.
static xmog_byte DIRECTIONALITY_RIGHT_TO_LEFT_OVERRIDE
 Strong bidirectional character type "RLO" in the Unicode specification.
static xmog_byte DIRECTIONALITY_SEGMENT_SEPARATOR
 Neutral bidirectional character type "S" in the Unicode specification.
static xmog_byte DIRECTIONALITY_UNDEFINED
 Undefined bidirectional character type.
static xmog_byte DIRECTIONALITY_WHITESPACE
 Neutral bidirectional character type "WS" in the Unicode specification.
static xmog_byte ENCLOSING_MARK
 General category "Me" in the Unicode specification.
static xmog_byte END_PUNCTUATION
 General category "Pe" in the Unicode specification.
static xmog_byte FINAL_QUOTE_PUNCTUATION
 General category "Pf" in the Unicode specification.
static xmog_byte FORMAT
 General category "Cf" in the Unicode specification.
static xmog_byte INITIAL_QUOTE_PUNCTUATION
 General category "Pi" in the Unicode specification.
static xmog_byte LETTER_NUMBER
 General category "Nl" in the Unicode specification.
static xmog_byte LINE_SEPARATOR
 General category "Zl" in the Unicode specification.
static xmog_byte LOWERCASE_LETTER
 General category "Ll" in the Unicode specification.
static xmog_byte MATH_SYMBOL
 General category "Sm" in the Unicode specification.
static xmog_int MAX_RADIX
 The maximum radix available for conversion to and from strings.
static xmog_char MAX_VALUE
 The constant value of this field is the largest value of type char, '&#92;uFFFF'.
static xmog_int MIN_RADIX
 The minimum radix available for conversion to and from strings.
static xmog_char MIN_VALUE
 The constant value of this field is the smallest value of type char, '&#92;u0000'.
static xmog_byte MODIFIER_LETTER
 General category "Lm" in the Unicode specification.
static xmog_byte MODIFIER_SYMBOL
 General category "Sk" in the Unicode specification.
static xmog_byte NON_SPACING_MARK
 General category "Mn" in the Unicode specification.
static xmog_byte OTHER_LETTER
 General category "Lo" in the Unicode specification.
static xmog_byte OTHER_NUMBER
 General category "No" in the Unicode specification.
static xmog_byte OTHER_PUNCTUATION
 General category "Po" in the Unicode specification.
static xmog_byte OTHER_SYMBOL
 General category "So" in the Unicode specification.
static xmog_byte PARAGRAPH_SEPARATOR
 General category "Zp" in the Unicode specification.
static xmog_byte PRIVATE_USE
 General category "Co" in the Unicode specification.
static xmog_byte SPACE_SEPARATOR
 General category "Zs" in the Unicode specification.
static xmog_byte START_PUNCTUATION
 General category "Ps" in the Unicode specification.
static xmog_byte SURROGATE
 General category "Cs" in the Unicode specification.
static xmog_byte TITLECASE_LETTER
 General category "Lt" in the Unicode specification.
::java::lang::Class TYPE
 The Class instance representing the primitive type char.
static xmog_byte UNASSIGNED
 General category "Cn" in the Unicode specification.
static xmog_byte UPPERCASE_LETTER
 General category "Lu" in the Unicode specification.

Classes

class  Subset
 Instances of this class represent particular subsets of the Unicode character set. More...
class  UnicodeBlock
 A family of character subsets representing the character blocks in the Unicode specification. More...

Detailed Description

The Character class wraps a value of the primitive type char in an object.

An object of type Character contains a single field whose type is char.

In addition, this class provides several methods for determining a character's category (lowercase letter, digit, etc.) and for converting characters from uppercase to lowercase and vice versa.

Character information is based on the Unicode Standard, version 3.0.

The methods and data of class Character are defined by the information in the UnicodeData file that is part of the Unicode Character Database maintained by the Unicode Consortium. This file specifies various properties including name and general category for every defined Unicode code point or character range.

The file and its description are available from the Unicode Consortium at:

Author:
Lee Boynton

Guy Steele

Akira Tanaka


Constructor & Destructor Documentation

java::lang::Character::Character jchar  value,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
 

Constructs a newly allocated Character object that represents the specified char value.

Parameters:
value the value to be represented by the Character object.
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.


Member Function Documentation

jchar java::lang::Character::charValue ::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
 

Returns the value of this Character object.

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 primitive char value represented by this object.

jint java::lang::Character::compareTo const ::java::lang::Character anotherCharacter,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
 

Compares two Character objects numerically.

Parameters:
anotherCharacter the Character to be compared.
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 value 0 if the argument Character is equal to this Character; a value less than 0 if this Character is numerically less than the Character argument; and a value greater than 0 if this Character is numerically greater than the Character argument (unsigned comparison). Note that this is strictly a numerical comparison; it is not locale-dependent.

jint java::lang::Character::compareTo const ::java::lang::Object o,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[virtual]
 

Compares this Character object to another object.

If the object is a Character, this function behaves like compareTo(Character). Otherwise, it throws a ClassCastException (as Character objects are comparable only to other Character objects).

Parameters:
o the Object to be compared.
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 value 0 if the argument is a Character numerically equal to this Character; a value less than 0 if the argument is a Character numerically greater than this Character; and a value greater than 0 if the argument is a Character numerically less than this Character.

Reimplemented from java::lang::Comparable.

static jint java::lang::Character::digit jchar  ch,
jint  radix,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Returns the numeric value of the character ch in the specified radix.

If the radix is not in the range MIN_RADIX <= radix <= MAX_RADIX or if the value of ch is not a valid digit in the specified radix, -1 is returned. A character is a valid digit if at least one of the following is true:

  • The method isDigit is true of the character and the Unicode decimal digit value of the character (or its single-character decomposition) is less than the specified radix. In this case the decimal digit value is returned.
  • The character is one of the uppercase Latin letters 'A' through 'Z' and its code is less than radix + 'A' - 10. In this case, ch - 'A' + 10 is returned.
  • The character is one of the lowercase Latin letters 'a' through 'z' and its code is less than radix + 'a' - 10. In this case, ch - 'a' + 10 is returned.

Parameters:
ch the character to be converted.
radix the radix.
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 numeric value represented by the character in the specified radix.

bool java::lang::Character::equals const ::java::lang::Object obj,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[virtual]
 

Compares this object against the specified object.

The result is true if and only if the argument is not null and is a Character object that represents the same char value as this object.

Parameters:
obj the object to compare with.
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:
true if the objects are the same; false otherwise.

Reimplemented from java::lang::Object.

static jchar java::lang::Character::forDigit jint  digit,
jint  radix,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines the character representation for a specific digit in the specified radix.

If the value of radix is not a valid radix, or the value of digit is not a valid digit in the specified radix, the null character ('&#92;u0000') is returned.

The radix argument is valid if it is greater than or equal to MIN_RADIX and less than or equal to MAX_RADIX. The digit argument is valid if 0 <=digit < radix.

If the digit is less than 10, then '0' + digit is returned. Otherwise, the value 'a' + digit - 10 is returned.

Parameters:
digit the number to convert to a character.
radix the radix.
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 char representation of the specified digit in the specified radix.

static jbyte java::lang::Character::getDirectionality jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Returns the Unicode directionality property for the given character.

Character directionality is used to calculate the visual ordering of text. The directionality value of undefined char values is DIRECTIONALITY_UNDEFINED.

Parameters:
ch char for which the directionality property is requested.
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 directionality property of the char value.

static jint java::lang::Character::getNumericValue jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Returns the int value that the specified Unicode character represents.

For example, the character '&#92;u216C' (the roman numeral fifty) will return an int with a value of 50.

The letters A-Z in their uppercase ('&#92;u0041' through '&#92;u005A'), lowercase ('&#92;u0061' through '&#92;u007A'), and full width variant ('&#92;uFF21' through '&#92;uFF3A' and '&#92;uFF41' through '&#92;uFF5A') forms have numeric values from 10 through 35. This is independent of the Unicode specification, which does not assign numeric values to these char values.

If the character does not have a numeric value, then -1 is returned. If the character has a numeric value that cannot be represented as a nonnegative integer (for example, a fractional value), then -2 is returned.

Parameters:
ch the character to be converted.
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 numeric value of the character, as a nonnegative int value; -2 if the character has a numeric value that is not a nonnegative integer; -1 if the character has no numeric value.

static jint java::lang::Character::getType jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Returns a value indicating a character's general category.

Parameters:
ch the character to be tested.
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 value of type int representing the character's general category.

jint java::lang::Character::hashCode ::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[virtual]
 

Returns a hash code for this Character.

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 hash code value for this object.

Reimplemented from java::lang::Object.

static bool java::lang::Character::isDefined jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines if a character is defined in Unicode.

A character is defined if at least one of the following is true:

  • It has an entry in the UnicodeData file.
  • It has a value in a range defined by the UnicodeData file.

Parameters:
ch the character to be tested
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:
true if the character has a defined meaning in Unicode; false otherwise.

static bool java::lang::Character::isDigit jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines if the specified character is a digit.

A character is a digit if its general category type, provided by Character.getType(ch), is DECIMAL_DIGIT_NUMBER.

Some Unicode character ranges that contain digits:

  • '&#92;u0030' through '&#92;u0039', ISO-LATIN-1 digits ('0' through '9')
  • '&#92;u0660' through '&#92;u0669', Arabic-Indic digits
  • '&#92;u06F0' through '&#92;u06F9', Extended Arabic-Indic digits
  • '&#92;u0966' through '&#92;u096F', Devanagari digits
  • '&#92;uFF10' through '&#92;uFF19', Fullwidth digits

Many other character ranges contain digits as well.

Parameters:
ch the character to be tested.
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:
true if the character is a digit; false otherwise.

static bool java::lang::Character::isIdentifierIgnorable jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines if the specified character should be regarded as an ignorable character in a Java identifier or a Unicode identifier.

The following Unicode characters are ignorable in a Java identifier or a Unicode identifier:

  • ISO control characters that are not whitespace
    • '&#92;u0000' through '&#92;u0008'
    • '&#92;u000E' through '&#92;u001B'
    • '&#92;u007F' through '&#92;u009F'

  • all characters that have the FORMAT general category value

Parameters:
ch the character to be tested.
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:
true if the character is an ignorable control character that may be part of a Java or Unicode identifier; false otherwise.

static bool java::lang::Character::isISOControl jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines if the specified character is an ISO control character.

A character is considered to be an ISO control character if its code is in the range '&#92;u0000' through '&#92;u001F' or in the range '&#92;u007F' through '&#92;u009F'.

Parameters:
ch the character to be tested.
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:
true if the character is an ISO control character; false otherwise.

static bool java::lang::Character::isJavaIdentifierPart jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines if the specified character may be part of a Java identifier as other than the first character.

A character may be part of a Java identifier if any of the following are true:

  • it is a letter
  • it is a currency symbol (such as '$')
  • it is a connecting punctuation character (such as '_')
  • it is a digit
  • it is a numeric letter (such as a Roman numeral character)
  • it is a combining mark
  • it is a non-spacing mark
  • isIdentifierIgnorable returns true for the character

Parameters:
ch the character to be tested.
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:
true if the character may be part of a Java identifier; false otherwise.

static bool java::lang::Character::isJavaIdentifierStart jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines if the specified character is permissible as the first character in a Java identifier.

A character may start a Java identifier if and only if one of the following conditions is true:

  • isLetter(ch) returns true
  • getType(ch) returns LETTER_NUMBER
  • ch is a currency symbol (such as "$")
  • ch is a connecting punctuation character (such as "_").

Parameters:
ch the character to be tested.
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:
true if the character may start a Java identifier; false otherwise.

static bool java::lang::Character::isJavaLetter jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines if the specified character is permissible as the first character in a Java identifier.

A character may start a Java identifier if and only if one of the following is true:

  • isLetter(ch) returns true
  • getType(ch) returns LETTER_NUMBER
  • ch is a currency symbol (such as "$")
  • ch is a connecting punctuation character (such as "_").

Parameters:
ch the character to be tested.
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:
true if the character may start a Java identifier; false otherwise.

static bool java::lang::Character::isJavaLetterOrDigit jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines if the specified character may be part of a Java identifier as other than the first character.

A character may be part of a Java identifier if and only if any of the following are true:

  • it is a letter
  • it is a currency symbol (such as '$')
  • it is a connecting punctuation character (such as '_')
  • it is a digit
  • it is a numeric letter (such as a Roman numeral character)
  • it is a combining mark
  • it is a non-spacing mark
  • isIdentifierIgnorable returns true for the character.

Parameters:
ch the character to be tested.
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:
true if the character may be part of a Java identifier; false otherwise.

static bool java::lang::Character::isLetter jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines if the specified character is a letter.

A character is considered to be a letter if its general category type, provided by Character.getType(ch), is any of the following:

  • UPPERCASE_LETTER
  • LOWERCASE_LETTER
  • TITLECASE_LETTER
  • MODIFIER_LETTER
  • OTHER_LETTER

Not all letters have case. Many characters are letters but are neither uppercase nor lowercase nor titlecase.

Parameters:
ch the character to be tested.
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:
true if the character is a letter; false otherwise.

static bool java::lang::Character::isLetterOrDigit jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines if the specified character is a letter or digit.

A character is considered to be a letter or digit if either Character.isLetter(char ch) or Character.isDigit(char ch) returns true for the character.

Parameters:
ch the character to be tested.
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:
true if the character is a letter or digit; false otherwise.

static bool java::lang::Character::isLowerCase jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines if the specified character is a lowercase character.

A character is lowercase if its general category type, provided by Character.getType(ch), is LOWERCASE_LETTER.

The following are examples of lowercase characters:

<blockquote>

                 a b c d e f g h i j k l m n o p q r s t u v w x y z
                 '&#92;u00DF' '&#92;u00E0' '&#92;u00E1' '&#92;u00E2' '&#92;u00E3' '&#92;u00E4' '&#92;u00E5' '&#92;u00E6' 
                 '&#92;u00E7' '&#92;u00E8' '&#92;u00E9' '&#92;u00EA' '&#92;u00EB' '&#92;u00EC' '&#92;u00ED' '&#92;u00EE'
                 '&#92;u00EF' '&#92;u00F0' '&#92;u00F1' '&#92;u00F2' '&#92;u00F3' '&#92;u00F4' '&#92;u00F5' '&#92;u00F6'
                 '&#92;u00F8' '&#92;u00F9' '&#92;u00FA' '&#92;u00FB' '&#92;u00FC' '&#92;u00FD' '&#92;u00FE' '&#92;u00FF'

</blockquote>

Many other Unicode characters are lowercase too.

Parameters:
ch the character to be tested.
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:
true if the character is lowercase; false otherwise.

static bool java::lang::Character::isMirrored jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines whether the character is mirrored according to the Unicode specification.

Mirrored characters should have their glyphs horizontally mirrored when displayed in text that is right-to-left. For example, '&#92;u0028' LEFT PARENTHESIS is semantically defined to be an opening parenthesis. This will appear as a "(" in text that is left-to-right but as a ")" in text that is right-to-left.

Parameters:
ch char for which the mirrored property is requested
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:
true if the char is mirrored, false if the char is not mirrored or is not defined.

static bool java::lang::Character::isSpace jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines if the specified character is ISO-LATIN-1 white space.

This method returns true for the following five characters only:
'' '&#92;u0009' HORIZONTAL TABULATION
'
'
'&#92;u000A' NEW LINE
'' '&#92;u000C' FORM FEED
'' '&#92;u000D' CARRIAGE RETURN
' ' '&#92;u0020' SPACE

Parameters:
ch the character to be tested.
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:
true if the character is ISO-LATIN-1 white space; false otherwise.

static bool java::lang::Character::isSpaceChar jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines if the specified character is a Unicode space character.

A character is considered to be a space character if and only if it is specified to be a space character by the Unicode standard. This method returns true if the character's general category type is any of the following:

  • SPACE_SEPARATOR
  • LINE_SEPARATOR
  • PARAGRAPH_SEPARATOR

Parameters:
ch the character to be tested.
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:
true if the character is a space character; false otherwise.

static bool java::lang::Character::isTitleCase jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines if the specified character is a titlecase character.

A character is a titlecase character if its general category type, provided by Character.getType(ch), is TITLECASE_LETTER.

Some characters look like pairs of Latin letters. For example, there is an uppercase letter that looks like "LJ" and has a corresponding lowercase letter that looks like "lj". A third form, which looks like "Lj", is the appropriate form to use when rendering a word in lowercase with initial capitals, as for a book title.

These are some of the Unicode characters for which this method returns true:

  • LATIN CAPITAL LETTER D WITH SMALL LETTER Z WITH CARON
  • LATIN CAPITAL LETTER L WITH SMALL LETTER J
  • LATIN CAPITAL LETTER N WITH SMALL LETTER J
  • LATIN CAPITAL LETTER D WITH SMALL LETTER Z

Many other Unicode characters are titlecase too.

Parameters:
ch the character to be tested.
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:
true if the character is titlecase; false otherwise.

static bool java::lang::Character::isUnicodeIdentifierPart jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines if the specified character may be part of a Unicode identifier as other than the first character.

A character may be part of a Unicode identifier if and only if one of the following statements is true:

  • it is a letter
  • it is a connecting punctuation character (such as '_')
  • it is a digit
  • it is a numeric letter (such as a Roman numeral character)
  • it is a combining mark
  • it is a non-spacing mark
  • isIdentifierIgnorable returns true for this character.

Parameters:
ch the character to be tested.
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:
true if the character may be part of a Unicode identifier; false otherwise.

static bool java::lang::Character::isUnicodeIdentifierStart jchar  ch,
::xmog_localenv p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
[static]
 

Determines if the specified character is permissible as the first character in a Unicode identifier.

A character may start a Unicode identifier if and only if one of the following conditions is true:

Parameters: