OpenTop C++ class: IllegalCharacterException

Overview

Namespace

Class

Glossary

Index

OpenTop Portal

OpenTop 1.5

PREV EXCEPTION NEXT EXCEPTION

FRAMES NO FRAMES

Cross-Platform C++

SUMMARY: CONSTRUCTOR | METHOD

DETAIL: CONSTRUCTOR | METHOD

ot
class IllegalCharacterException

#include "ot/base/IllegalCharacterException.h"

Thrown when an illegal character value is detected. An illegal character value has a code-point value outside the range of supported Unicode characters.

This exception can be thrown when OpenTop is using UTF-8 or UTF-16 as the native OpenTop encoding and the application creates a CharType sequence that would decode into an illegal Unicode character.

This exception can also be thrown when an application attempts to construct a Character object with an illegal Unicode code-point value. This situation is most likely when OpenTop has been configured to use ISO-8859-1 (Latin1) chacacters, where the maximum permitted code-point value is U+00FE.

Constructor/Destructor Summary
`IllegalCharacterException()` Constructs an IllegalCharacterException without a detail message.
`IllegalCharacterException(const String& message)` Constructs an IllegalCharacterException with a detail message.
`IllegalCharacterException(UCS4Char ch)` Constructs an IllegalCharacterException with the code point for the illegal character.

Method Summary
`virtual String`	`getExceptionType() const` Returns the class name as a String.
`virtual String`	`getLocalizedDescription() const` Returns a localized description of the Exception type or, if a native language translation is unavailable, an empty string.

Methods inherited from class ot::Exception

getDescription(), getMessage(), setMessage(const String&), toString()

Constructor/Destructor Detail

IllegalCharacterException

 IllegalCharacterException()

Constructs an IllegalCharacterException without a detail message.

IllegalCharacterException

 IllegalCharacterException(const String& message)

Constructs an IllegalCharacterException with a detail message.

Parameters:: message - the detail message.

IllegalCharacterException

 IllegalCharacterException(UCS4Char ch)

Constructs an IllegalCharacterException with the code point for the illegal character. @ch the illegal or unmappable character.

Method Detail

getExceptionType

virtual String getExceptionType() const

Returns the class name as a String. This method should be overridden in all derived classes to return the name of the derived class.

See also:: getDescription()

getLocalizedDescription

virtual String getLocalizedDescription() const

Returns a localized description of the Exception type or, if a native language translation is unavailable, an empty string. The base class implementation always returns an empty string.