Package com.ibm.icu.text

Extensions and enhancements to java.text to support unicode transforms, UnicodeSet, surrogate char utilities, UCA collation, normalization, break iteration (rule and dictionary based), enhanced number format, international string searching, and arabic shaping.

See: Description

Interface Summary

Interface	Description
Collator.ReorderCodes	Reordering codes for non-script groups that can be reordered under collation.
RbnfLenientScanner	Deprecated ICU 54
RbnfLenientScannerProvider	Deprecated ICU 54
Replaceable	Replaceable is an interface representing a string of characters that supports the replacement of a range of itself with a new string of characters.
StringTransform	Provide a base class for Transforms that focuses just on the transformation of the text.
SymbolTable	An interface that defines both lookup protocol and parsing of symbolic names.
Transform<S,D>	Provide an interface for Transforms that focuses just on the transformation of the text.
Transliterator.Factory	The factory interface for transliterators.
UForwardCharacterIterator	Interface that defines an API for forward-only iteration on text objects.
UnicodeMatcher	UnicodeMatcher defines a protocol for objects that can match a range of characters in a Replaceable string.

Class Summary

Class	Description
AlphabeticIndex<V>	AlphabeticIndex supports the creation of a UI index appropriate for a given language.
AlphabeticIndex.Bucket<V>	An index "bucket" with a label string and type.
AlphabeticIndex.ImmutableIndex<V>	Immutable, thread-safe version of AlphabeticIndex.
AlphabeticIndex.Record<V>	A (name, data) pair, to be sorted by name into one of the index buckets.
ArabicShaping	Shape Arabic text on a character basis.
Bidi	Bidi algorithm for ICU This is an implementation of the Unicode Bidirectional Algorithm.
BidiClassifier	Overrides default Bidi class values with custom ones.
BidiRun	A BidiRun represents a sequence of characters at the same embedding level.
BreakIterator	[icu enhancement] ICU's replacement for java.text.BreakIterator.
CanonicalIterator	This class allows one to iterate through all the strings that are canonically equivalent to a given string.
CharsetDetector	CharsetDetector provides a facility for detecting the charset or encoding of character data in an unknown format.
CharsetMatch	This class represents a charset that has been identified by a CharsetDetector as a possible encoding for a set of input data.
ChineseDateFormat	Deprecated ICU 50 Use SimpleDateFormat instead.
ChineseDateFormat.Field	Deprecated ICU 50
ChineseDateFormatSymbols	Deprecated ICU 50
CollationElementIterator	CollationElementIterator is an iterator created by a RuleBasedCollator to walk through a string.
CollationKey	A CollationKey represents a String under the rules of a specific Collator object.
CollationKey.BoundMode	Options that used in the API CollationKey.getBound() for getting a CollationKey based on the bound mode requested.
Collator	[icu enhancement] ICU's replacement for java.text.Collator.
Collator.CollatorFactory	A factory used with registerFactory to register multiple collators and provide display names for them.
CompactDecimalFormat	The CompactDecimalFormat produces abbreviated numbers, suitable for display in environments will limited real estate.
ComposedCharIter	Deprecated ICU 2.2
CurrencyDisplayNames	Returns currency names localized for a locale.
CurrencyMetaInfo	Provides information about currencies that is not specific to a locale.
CurrencyMetaInfo.CurrencyDigits	Represents the raw information about fraction digits and rounding increment.
CurrencyMetaInfo.CurrencyFilter	A filter used to select which currency info is returned.
CurrencyMetaInfo.CurrencyInfo	Represents a complete currency info record listing the region, currency, from and to dates, and priority.
CurrencyPluralInfo	This class represents the information needed by DecimalFormat to format currency plural, such as "3.00 US dollars" or "1.00 US dollar".
DateFormat	[icu enhancement] ICU's replacement for java.text.DateFormat.
DateFormat.Field	The instances of this inner class are used as attribute keys and values in AttributedCharacterIterator that DateFormat.formatToCharacterIterator() method returns.
DateFormatSymbols	[icu enhancement] ICU's replacement for java.text.DateFormatSymbols.
DateIntervalFormat	DateIntervalFormat is a class for formatting and parsing date intervals in a language-independent manner.
DateIntervalInfo	DateIntervalInfo is a public class for encapsulating localizable date time interval patterns.
DateIntervalInfo.PatternInfo	PatternInfo class saves the first and second part of interval pattern, and whether the interval pattern is earlier date first.
DateTimePatternGenerator	This class provides flexible generation of date format patterns, like "yy-MM-dd".
DateTimePatternGenerator.FormatParser	Deprecated This API is ICU internal only.
DateTimePatternGenerator.PatternInfo	PatternInfo supplies output parameters for addPattern(...).
DateTimePatternGenerator.VariableField	Deprecated This API is ICU internal only.
DecimalFormat	[icu enhancement] ICU's replacement for java.text.DecimalFormat.
DecimalFormatSymbols	[icu enhancement] ICU's replacement for java.text.DecimalFormatSymbols.
DurationFormat	This class implements a formatter over a duration in time such as "2 days from now" or "3 hours ago".
FilteredBreakIteratorBuilder	Deprecated This API might change or be removed in a future release.
FilteredNormalizer2	Normalization filtered by a UnicodeSet.
IdentifierInfo	Deprecated This API is ICU internal only.
IDNA	Abstract base class for IDNA processing.
IDNA.Info	Output container for IDNA processing errors.
ListFormatter	Immutable class for formatting a list, using data from CLDR (or supplied separately).
LocaleDisplayNames	Returns display names of ULocales and components of ULocales.
LocaleDisplayNames.UiListItem	Struct-like class used to return information for constructing a UI list, each corresponding to a locale.
MeasureFormat	A formatter for Measure objects.
MessageFormat	[icu enhancement] ICU's replacement for java.text.MessageFormat.
MessageFormat.Field	Defines constants that are used as attribute keys in the AttributedCharacterIterator returned from MessageFormat.formatToCharacterIterator.
MessagePattern	Parses and represents ICU MessageFormat patterns.
MessagePattern.Part	A message pattern "part", representing a pattern parsing event.
MessagePatternUtil	Utilities for working with a MessagePattern.
MessagePatternUtil.ArgNode	A piece of MessageNode contents representing a message argument and its details.
MessagePatternUtil.ComplexArgStyleNode	A Node representing details of the argument style of a complex argument.
MessagePatternUtil.MessageContentsNode	A piece of MessageNode contents.
MessagePatternUtil.MessageNode	A Node representing a parsed MessageFormat pattern string.
MessagePatternUtil.Node	Common base class for all elements in a tree of nodes returned by MessagePatternUtil.buildMessageNode(MessagePattern).
MessagePatternUtil.TextNode	Literal text, a piece of MessageNode contents.
MessagePatternUtil.VariantNode	A Node representing a nested message (nested inside an argument) with its selection criterium.
Normalizer	Unicode Normalization Unicode normalization API normalize transforms Unicode text into an equivalent composed or decomposed form, allowing for easier sorting and searching of text.
Normalizer.Mode	Constants for normalization modes.
Normalizer.QuickCheckResult	Result values for quickCheck().
Normalizer2	Unicode normalization functionality for standard Unicode normalization or for using custom mapping tables.
NumberFormat	[icu enhancement] ICU's replacement for java.text.NumberFormat.
NumberFormat.Field	The instances of this inner class are used as attribute keys and values in AttributedCharacterIterator that NumberFormat.formatToCharacterIterator() method returns.
NumberFormat.NumberFormatFactory	A NumberFormatFactory is used to register new number formats.
NumberFormat.SimpleNumberFormatFactory	A NumberFormatFactory that supports a single locale.
NumberingSystem	NumberingSystem is the base class for all number systems.
PluralFormat	PluralFormat supports the creation of internationalized messages with plural inflection.
PluralRanges	Deprecated This API is ICU internal only.
PluralRules	Defines rules for mapping non-negative numeric values onto a small set of keywords.
PluralRules.Factory	Deprecated This API is ICU internal only.
PluralRules.FixedDecimal	Deprecated This API is ICU internal only.
PluralRules.FixedDecimalRange	Deprecated This API is ICU internal only.
PluralRules.FixedDecimalSamples	Deprecated This API is ICU internal only.
PluralSamples	Deprecated This API is ICU internal only.
RawCollationKey	Simple class wrapper to store the internal byte representation of a CollationKey.
RelativeDateTimeFormatter	Formats simple relative dates.
ReplaceableString	ReplaceableString is an adapter class that implements the Replaceable API around an ordinary StringBuffer.
RuleBasedBreakIterator	Rule Based Break Iterator This is a port of the C++ class RuleBasedBreakIterator from ICU4C.
RuleBasedCollator	RuleBasedCollator is a concrete subclass of Collator.
RuleBasedNumberFormat	A class that formats numbers according to a set of rules.
RuleBasedTransliterator	Deprecated This API is ICU internal only.
ScientificNumberFormatter	A formatter that formats numbers in user-friendly scientific notation.
SearchIterator	SearchIterator is an abstract base class that provides methods to search for a pattern within a text string.
SelectFormat	SelectFormat supports the creation of internationalized messages by selecting phrases based on keywords.
SimpleDateFormat	[icu enhancement] ICU's replacement for java.text.SimpleDateFormat.
SpoofChecker	Unicode Security and Spoofing Detection.
SpoofChecker.Builder	SpoofChecker Builder.
SpoofChecker.CheckResult	A struct-like class to hold the results of a Spoof Check operation.
StringCharacterIterator	Deprecated ICU 2.4.
StringPrep	StringPrep API implements the StingPrep framework as described by RFC 3454.
StringSearch	StringSearch is a SearchIterator that provides language-sensitive text searching based on the comparison rules defined in a RuleBasedCollator object.
TimeUnitFormat	Deprecated ICU 53 use MeasureFormat instead.
TimeZoneFormat	TimeZoneFormat supports time zone display name formatting and parsing.
TimeZoneNames	TimeZoneNames is an abstract class representing the time zone display name data model defined by UTS#35 Unicode Locale Data Markup Language (LDML).
TimeZoneNames.Factory	Deprecated This API is ICU internal only.
TimeZoneNames.MatchInfo	A MatchInfo represents a time zone name match used by TimeZoneNames.find(CharSequence, int, EnumSet).
Transliterator	Transliterator is an abstract class that transliterates text from one format to another.
Transliterator.Position	Position structure for incremental transliteration.
UCharacterIterator	Abstract class that defines an API for iteration on text objects.This is an interface for forward and backward iteration and random access into a text object.
UFieldPosition	Deprecated This API is ICU internal only.
UFormat	An abstract class that extends Format to provide additional ICU protocol, specifically, the getLocale() API.
UnicodeCompressor	A compression engine implementing the Standard Compression Scheme for Unicode (SCSU) as outlined in Unicode Technical Report #6.
UnicodeDecompressor	A decompression engine implementing the Standard Compression Scheme for Unicode (SCSU) as outlined in Unicode Technical Report #6.
UnicodeFilter	UnicodeFilter defines a protocol for selecting a subset of the full range (U+0000 to U+FFFF) of Unicode characters.
UnicodeSet	A mutable set of Unicode characters and multicharacter strings.
UnicodeSet.EntryRange	A struct-like class used for iteration through ranges, for faster iteration than by String.
UnicodeSet.XSymbolTable	Internal class for customizing UnicodeSet parsing of properties.
UnicodeSetIterator	UnicodeSetIterator iterates over the contents of a UnicodeSet.
UnicodeSetSpanner	A helper class used to count, replace, and trim CharSequences based on UnicodeSet matches.
UTF16	Standalone utility class providing UTF16 character conversions and indexing conversions.
UTF16.StringComparator	UTF16 string comparator class.

Enum Summary

Enum	Description
AlphabeticIndex.Bucket.LabelType	Type of the label
CompactDecimalFormat.CompactStyle	Style parameter for CompactDecimalFormat.
DateFormat.BooleanAttribute	boolean attributes
DisplayContext	Display context settings.
DisplayContext.Type	Type values for DisplayContext
IDNA.Error	IDNA error bit set values.
ListFormatter.Style	Deprecated This API is ICU internal only.
LocaleDisplayNames.DialectHandling	Enum used in LocaleDisplayNames.getInstance(ULocale, DialectHandling).
MeasureFormat.FormatWidth	Formatting width enum.
MessagePattern.ApostropheMode	Mode for when an apostrophe starts quoted literal text for MessageFormat output.
MessagePattern.ArgType	Argument type constants.
MessagePattern.Part.Type	Part type constants.
MessagePatternUtil.MessageContentsNode.Type	The type of a piece of MessageNode contents.
Normalizer2.Mode	Constants for normalization modes.
PluralRules.KeywordStatus	Status of the keyword for the rules, given a set of explicit values.
PluralRules.PluralType	Type of plurals and PluralRules.
PluralRules.SampleType	Deprecated This API is ICU internal only.
PluralRules.StandardPluralCategories	Deprecated This API is ICU internal only.
RelativeDateTimeFormatter.AbsoluteUnit	Represents an absolute unit.
RelativeDateTimeFormatter.Direction	Represents a direction for an absolute unit e.g "Next Tuesday" or "Last Tuesday"
RelativeDateTimeFormatter.RelativeUnit	Represents the unit for formatting a relative date. e.g "in 5 days" or "in 3 months"
RelativeDateTimeFormatter.Style	The formatting style
SearchIterator.ElementComparisonType	Option to control how collation elements are compared.
SpoofChecker.RestrictionLevel	Constants from UAX 31 for use in setRestrictionLevel.
TimeZoneFormat.GMTOffsetPatternType	Offset pattern type enum.
TimeZoneFormat.ParseOption	Parse option enum, used for specifying optional parse behavior.
TimeZoneFormat.Style	Time zone display format style enum used by format/parse APIs in TimeZoneFormat.
TimeZoneFormat.TimeType	Time type enum used for receiving time type (standard time, daylight time or unknown) in TimeZoneFormat APIs.
TimeZoneNames.NameType	Time zone display name types
UnicodeSet.ComparisonStyle	Comparison style enums used by UnicodeSet.compareTo(UnicodeSet, ComparisonStyle).
UnicodeSet.SpanCondition	Argument values for whether span() and similar functions continue while the current character is contained vs.
UnicodeSetSpanner.CountMethod	Options for replaceFrom and countIn to control how to treat each matched span.
UnicodeSetSpanner.TrimOption	Options for the trim() method

Exception Summary

Exception	Description
ArabicShapingException	Thrown by ArabicShaping when there is a shaping error.
StringPrepParseException	Exception that signals an error has occurred while parsing the input to StringPrep or IDNA.

Package com.ibm.icu.text Description

Extensions and enhancements to java.text to support unicode transforms, UnicodeSet, surrogate char utilities, UCA collation, normalization, break iteration (rule and dictionary based), enhanced number format, international string searching, and arabic shaping.

• Unicode Transforms (Transliteration) convert between different representations of unicode text.
• UnicodeSet provides set operations on unicode characters and strings, and are representable as compact expressions.
• Surrogate character utilities (UTF16) provides indexing and substring operations on text containing surrogates.
• UCA collation implements the current Unicode Collation Algorithm. Data for many locale-specific collations is provided.
• Normalization supports standard Unicode normalization forms as well as FCD.
• Break iteration supports character, word, line, sentences, and title case breaks.
• Enhanced number format to 'spell out' numbers, padding and rounding control.
• Internationally sensitive string searching, uses collation.
• Arabic shaping converts between shaped and unshaped arabic characters and digits.