- All Implemented Interfaces:
Serializable
NumericShaper
class is used to convert Latin-1 (European)
digits to other Unicode decimal digits. Users of this class will
primarily be people who wish to present data using
national digit shapes, but find it more convenient to represent the
data internally using Latin-1 (European) digits. This does not
interpret the deprecated numeric shape selector character (U+206E).
Instances of NumericShaper
are typically applied
as attributes to text with the
NUMERIC_SHAPING
attribute
of the TextAttribute
class.
For example, this code snippet causes a TextLayout
to
shape European digits to Arabic in an Arabic context:
Map map = new HashMap(); map.put(TextAttribute.NUMERIC_SHAPING, NumericShaper.getContextualShaper(NumericShaper.ARABIC)); FontRenderContext frc = ...; TextLayout layout = new TextLayout(text, map, frc); layout.draw(g2d, x, y);
It is also possible to perform numeric shaping explicitly using instances of
NumericShaper
, as this code snippet demonstrates:char[] text = ...; // shape all EUROPEAN digits (except zero) to ARABIC digits NumericShaper shaper = NumericShaper.getShaper(NumericShaper.ARABIC); shaper.shape(text, start, count); // shape European digits to ARABIC digits if preceding text is Arabic, or // shape European digits to TAMIL digits if preceding text is Tamil, or // leave European digits alone if there is no preceding text, or // preceding text is neither Arabic nor Tamil NumericShaper shaper = NumericShaper.getContextualShaper(NumericShaper.ARABIC | NumericShaper.TAMIL, NumericShaper.EUROPEAN); shaper.shape(text, start, count);
Bit mask- and enum-based Unicode ranges
This class supports two different programming interfaces to
represent Unicode ranges for script-specific digits: bit
mask-based ones, such as NumericShaper.ARABIC
, and
enum-based ones, such as NumericShaper.Range.ARABIC
.
Multiple ranges can be specified by ORing bit mask-based constants,
such as:
or creating aNumericShaper.ARABIC | NumericShaper.TAMIL
Set
with the NumericShaper.Range
constants, such as:
The enum-based ranges are a super set of the bit mask-based ones.EnumSet.of(NumericShaper.Range.ARABIC, NumericShaper.Range.TAMIL)
If the two interfaces are mixed (including serialization),
Unicode range values are mapped to their counterparts where such
mapping is possible, such as NumericShaper.Range.ARABIC
from/to NumericShaper.ARABIC
. If any unmappable range
values are specified, such as NumericShaper.Range.BALINESE
,
those ranges are ignored.
Decimal Digits Precedence
A Unicode range may have more than one set of decimal digits. If multiple decimal digits sets are specified for the same Unicode range, one of the sets will take precedence as follows.
Unicode Range | NumericShaper Constants
| Precedence |
---|---|---|
Arabic | NumericShaper.ARABIC
NumericShaper.EASTERN_ARABIC
| NumericShaper.EASTERN_ARABIC
|
NumericShaper.Range.ARABIC
NumericShaper.Range.EASTERN_ARABIC
| NumericShaper.Range.EASTERN_ARABIC
| |
Tai Tham | NumericShaper.Range.TAI_THAM_HORA
NumericShaper.Range.TAI_THAM_THAM
| NumericShaper.Range.TAI_THAM_THAM
|
- Since:
- 1.4
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
ANumericShaper.Range
represents a Unicode range of a script having its own decimal digits. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Identifies all ranges, for full contextual shaping.static final int
Identifies the ARABIC range and decimal base.static final int
Identifies the BENGALI range and decimal base.static final int
Identifies the DEVANAGARI range and decimal base.static final int
Identifies the ARABIC range and ARABIC_EXTENDED decimal base.static final int
Identifies the ETHIOPIC range and decimal base.static final int
Identifies the Latin-1 (European) and extended range, and Latin-1 (European) decimal base.static final int
Identifies the GUJARATI range and decimal base.static final int
Identifies the GURMUKHI range and decimal base.static final int
Identifies the KANNADA range and decimal base.static final int
Identifies the KHMER range and decimal base.static final int
Identifies the LAO range and decimal base.static final int
Identifies the MALAYALAM range and decimal base.static final int
Identifies the MONGOLIAN range and decimal base.static final int
Identifies the MYANMAR range and decimal base.static final int
Identifies the ORIYA range and decimal base.static final int
Identifies the TAMIL range and decimal base.static final int
Identifies the TELUGU range and decimal base.static final int
Identifies the THAI range and decimal base.static final int
Identifies the TIBETAN range and decimal base. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returnstrue
if the specified object is an instance ofNumericShaper
and shapes identically to this one, regardless of the range representations, the bit mask or the enum.static NumericShaper
getContextualShaper
(int ranges) Returns a contextual shaper for the provided unicode range(s).static NumericShaper
getContextualShaper
(int ranges, int defaultContext) Returns a contextual shaper for the provided unicode range(s).static NumericShaper
getContextualShaper
(Set<NumericShaper.Range> ranges) Returns a contextual shaper for the provided Unicode range(s).static NumericShaper
getContextualShaper
(Set<NumericShaper.Range> ranges, NumericShaper.Range defaultContext) Returns a contextual shaper for the provided Unicode range(s).int
Returns anint
that ORs together the values for all the ranges that will be shaped.Returns aSet
representing all the Unicode ranges in thisNumericShaper
that will be shaped.static NumericShaper
getShaper
(int singleRange) Returns a shaper for the provided unicode range.static NumericShaper
getShaper
(NumericShaper.Range singleRange) Returns a shaper for the provided Unicode range.int
hashCode()
Returns a hash code for this shaper.boolean
Returns aboolean
indicating whether or not this shaper shapes contextually.void
shape
(char[] text, int start, int count) Converts the digits in the text that occur between start and start + count.void
shape
(char[] text, int start, int count, int context) Converts the digits in the text that occur between start and start + count, using the provided context.void
shape
(char[] text, int start, int count, NumericShaper.Range context) Converts the digits in the text that occur betweenstart
andstart + count
, using the providedcontext
.toString()
Returns aString
that describes this shaper.
-
Field Details
-
EUROPEAN
public static final int EUROPEANIdentifies the Latin-1 (European) and extended range, and Latin-1 (European) decimal base.- See Also:
-
ARABIC
public static final int ARABICIdentifies the ARABIC range and decimal base.- See Also:
-
EASTERN_ARABIC
public static final int EASTERN_ARABICIdentifies the ARABIC range and ARABIC_EXTENDED decimal base.- See Also:
-
DEVANAGARI
public static final int DEVANAGARIIdentifies the DEVANAGARI range and decimal base.- See Also:
-
BENGALI
public static final int BENGALIIdentifies the BENGALI range and decimal base.- See Also:
-
GURMUKHI
public static final int GURMUKHIIdentifies the GURMUKHI range and decimal base.- See Also:
-
GUJARATI
public static final int GUJARATIIdentifies the GUJARATI range and decimal base.- See Also:
-
ORIYA
public static final int ORIYAIdentifies the ORIYA range and decimal base.- See Also:
-
TAMIL
public static final int TAMILIdentifies the TAMIL range and decimal base.- See Also:
-
TELUGU
public static final int TELUGUIdentifies the TELUGU range and decimal base.- See Also:
-
KANNADA
public static final int KANNADAIdentifies the KANNADA range and decimal base.- See Also:
-
MALAYALAM
public static final int MALAYALAMIdentifies the MALAYALAM range and decimal base.- See Also:
-
THAI
public static final int THAIIdentifies the THAI range and decimal base.- See Also:
-
LAO
public static final int LAOIdentifies the LAO range and decimal base.- See Also:
-
TIBETAN
public static final int TIBETANIdentifies the TIBETAN range and decimal base.- See Also:
-
MYANMAR
public static final int MYANMARIdentifies the MYANMAR range and decimal base.- See Also:
-
ETHIOPIC
public static final int ETHIOPICIdentifies the ETHIOPIC range and decimal base.- See Also:
-
KHMER
public static final int KHMERIdentifies the KHMER range and decimal base.- See Also:
-
MONGOLIAN
public static final int MONGOLIANIdentifies the MONGOLIAN range and decimal base.- See Also:
-
ALL_RANGES
public static final int ALL_RANGESIdentifies all ranges, for full contextual shaping.This constant specifies all of the bit mask-based ranges. Use
EnumSet.allOf(NumericShaper.Range.class)
to specify all of the enum-based ranges.- See Also:
-
-
Method Details
-
getShaper
Returns a shaper for the provided unicode range. All Latin-1 (EUROPEAN) digits are converted to the corresponding decimal unicode digits.- Parameters:
singleRange
- the specified Unicode range- Returns:
- a non-contextual numeric shaper
- Throws:
IllegalArgumentException
- if the range is not a single range
-
getShaper
Returns a shaper for the provided Unicode range. All Latin-1 (EUROPEAN) digits are converted to the corresponding decimal digits of the specified Unicode range.- Parameters:
singleRange
- the Unicode range given by aNumericShaper.Range
constant.- Returns:
- a non-contextual
NumericShaper
. - Throws:
NullPointerException
- ifsingleRange
isnull
- Since:
- 1.7
-
getContextualShaper
Returns a contextual shaper for the provided unicode range(s). Latin-1 (EUROPEAN) digits are converted to the decimal digits corresponding to the range of the preceding text, if the range is one of the provided ranges. Multiple ranges are represented by or-ing the values together, such as,NumericShaper.ARABIC | NumericShaper.THAI
. The shaper assumes EUROPEAN as the starting context, that is, if EUROPEAN digits are encountered before any strong directional text in the string, the context is presumed to be EUROPEAN, and so the digits will not shape.- Parameters:
ranges
- the specified Unicode ranges- Returns:
- a shaper for the specified ranges
-
getContextualShaper
Returns a contextual shaper for the provided Unicode range(s). The Latin-1 (EUROPEAN) digits are converted to the decimal digits corresponding to the range of the preceding text, if the range is one of the provided ranges.The shaper assumes EUROPEAN as the starting context, that is, if EUROPEAN digits are encountered before any strong directional text in the string, the context is presumed to be EUROPEAN, and so the digits will not shape.
- Parameters:
ranges
- the specified Unicode ranges- Returns:
- a contextual shaper for the specified ranges
- Throws:
NullPointerException
- ifranges
isnull
.- Since:
- 1.7
-
getContextualShaper
Returns a contextual shaper for the provided unicode range(s). Latin-1 (EUROPEAN) digits will be converted to the decimal digits corresponding to the range of the preceding text, if the range is one of the provided ranges. Multiple ranges are represented by or-ing the values together, for example,NumericShaper.ARABIC | NumericShaper.THAI
. The shaper uses defaultContext as the starting context.- Parameters:
ranges
- the specified Unicode rangesdefaultContext
- the starting context, such asNumericShaper.EUROPEAN
- Returns:
- a shaper for the specified Unicode ranges.
- Throws:
IllegalArgumentException
- if the specifieddefaultContext
is not a single valid range.
-
getContextualShaper
public static NumericShaper getContextualShaper(Set<NumericShaper.Range> ranges, NumericShaper.Range defaultContext) Returns a contextual shaper for the provided Unicode range(s). The Latin-1 (EUROPEAN) digits will be converted to the decimal digits corresponding to the range of the preceding text, if the range is one of the provided ranges. The shaper usesdefaultContext
as the starting context.- Parameters:
ranges
- the specified Unicode rangesdefaultContext
- the starting context, such asNumericShaper.Range.EUROPEAN
- Returns:
- a contextual shaper for the specified Unicode ranges.
- Throws:
NullPointerException
- ifranges
ordefaultContext
isnull
- Since:
- 1.7
-
shape
public void shape(char[] text, int start, int count) Converts the digits in the text that occur between start and start + count.- Parameters:
text
- an array of characters to convertstart
- the index intotext
to start convertingcount
- the number of characters intext
to convert- Throws:
IndexOutOfBoundsException
- if start or start + count is out of boundsNullPointerException
- if text is null
-
shape
public void shape(char[] text, int start, int count, int context) Converts the digits in the text that occur between start and start + count, using the provided context. Context is ignored if the shaper is not a contextual shaper.- Parameters:
text
- an array of charactersstart
- the index intotext
to start convertingcount
- the number of characters intext
to convertcontext
- the context to which to convert the characters, such asNumericShaper.EUROPEAN
- Throws:
IndexOutOfBoundsException
- if start or start + count is out of boundsNullPointerException
- if text is nullIllegalArgumentException
- if this is a contextual shaper and the specifiedcontext
is not a single valid range.
-
shape
Converts the digits in the text that occur betweenstart
andstart + count
, using the providedcontext
.Context
is ignored if the shaper is not a contextual shaper.- Parameters:
text
- achar
arraystart
- the index intotext
to start convertingcount
- the number ofchar
s intext
to convertcontext
- the context to which to convert the characters, such asNumericShaper.Range.EUROPEAN
- Throws:
IndexOutOfBoundsException
- ifstart
orstart + count
is out of boundsNullPointerException
- iftext
orcontext
is null- Since:
- 1.7
-
isContextual
public boolean isContextual()Returns aboolean
indicating whether or not this shaper shapes contextually.- Returns:
true
if this shaper is contextual;false
otherwise.
-
getRanges
public int getRanges()Returns anint
that ORs together the values for all the ranges that will be shaped.For example, to check if a shaper shapes to Arabic, you would use the following:
if ((shaper.getRanges() & shaper.ARABIC) != 0) { ...
Note that this method supports only the bit mask-based ranges. Call
getRangeSet()
for the enum-based ranges.- Returns:
- the values for all the ranges to be shaped.
-
getRangeSet
Returns aSet
representing all the Unicode ranges in thisNumericShaper
that will be shaped.- Returns:
- all the Unicode ranges to be shaped.
- Since:
- 1.7
-
hashCode
-
equals
Returnstrue
if the specified object is an instance ofNumericShaper
and shapes identically to this one, regardless of the range representations, the bit mask or the enum. For example, the following code produces"true"
.NumericShaper ns1 = NumericShaper.getShaper(NumericShaper.ARABIC); NumericShaper ns2 = NumericShaper.getShaper(NumericShaper.Range.ARABIC); System.out.println(ns1.equals(ns2));
-
toString
-