com.phloc.commons.i18n

Class Codepoint

java.lang.Object

com.phloc.commons.i18n.Codepoint

All Implemented Interfaces:

Serializable, Comparable<Codepoint>

@NotThreadSafe
public final class Codepoint
extends Object
implements Serializable, Comparable<Codepoint>

Represents a single Unicode Codepoint

Author:

Apache Abdera, Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Codepoint(byte[] bytes, Charset encoding) Create a Codepoint from a byte array with the specified charset encoding.
Codepoint(char value) Create a codepoint from a single char
Codepoint(char[] value) Create a Codepoint from a char array.
Codepoint(char high, char low) Create a codepoint from a surrogate pair
Codepoint(CharSequence value) Create a Codepoint from a CharSequence.
Codepoint(Codepoint aCodepoint) Create a codepoint as a copy of another codepoint
Codepoint(int nValue) Create a codepoint from a specific integer value
Codepoint(String value) Create a Codepoint from a String.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Codepoint o)
boolean	equals(Object o)
byte[]	getAsBytes(Charset aCharset)
char[]	getAsChars()
String	getAsString()
int	getCharCount()
char	getHighSurrogate() Get the high surrogate of this Codepoint
char	getLowSurrogate() Get the low surrogate of this Codepoint
int	getPlane() Plane 0 (0000–FFFF): Basic Multilingual Plane (BMP).
int	getValue() The codepoint value
int	hashCode()
boolean	isAlpha()
boolean	isAlphaDigit()
boolean	isBidi() True if this Codepoint is a bidi control char
boolean	isDigit()
boolean	isHighSurrogate() True if this codepoint is a high surrogate
boolean	isLowSurrogate() True if this codepoint is a low surrogate
boolean	isSupplementary() True if this codepoint is supplementary
Codepoint	next() Get the next codepoint
Codepoint	previous() Get the previous codepoint

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Codepoint

public Codepoint(@Nonnull
         byte[] bytes,
         @Nonnull
         Charset encoding)

Create a Codepoint from a byte array with the specified charset encoding. Length must equal 1

Codepoint

public Codepoint(@Nonnull
         CharSequence value)

Create a Codepoint from a CharSequence. Length must equal 1 or 2

Codepoint

public Codepoint(@Nonnull
         String value)

Create a Codepoint from a String. Length must equal 1 or 2

Codepoint

public Codepoint(@Nonnull
         char[] value)

Create a Codepoint from a char array. Length must equal 1 or 2

Codepoint

public Codepoint(char value)

Create a codepoint from a single char

Codepoint

public Codepoint(char high,
         char low)

Create a codepoint from a surrogate pair

Codepoint

public Codepoint(@Nonnull
         Codepoint aCodepoint)

Create a codepoint as a copy of another codepoint

Codepoint

public Codepoint(@Nonnegative
         int nValue)

Create a codepoint from a specific integer value

Method Detail

getValue

@Nonnegative
public int getValue()

The codepoint value

isSupplementary

public boolean isSupplementary()

True if this codepoint is supplementary

isLowSurrogate

public boolean isLowSurrogate()

True if this codepoint is a low surrogate

isHighSurrogate

public boolean isHighSurrogate()

True if this codepoint is a high surrogate

getHighSurrogate

public char getHighSurrogate()

Get the high surrogate of this Codepoint

getLowSurrogate

public char getLowSurrogate()

Get the low surrogate of this Codepoint

isBidi

public boolean isBidi()

True if this Codepoint is a bidi control char

isDigit

public boolean isDigit()

isAlpha

public boolean isAlpha()

isAlphaDigit

public boolean isAlphaDigit()

getAsString

@Nonnull
@Nonempty
public String getAsString()

getAsChars

@Nonnull
@ReturnsMutableCopy
public char[] getAsChars()

getCharCount

@Nonnegative
public int getCharCount()

Returns:

The number of chars necessary to represent this codepoint. Returns 2 if this is a supplementary codepoint, 1 otherwise.

getAsBytes

@Nonnull
public byte[] getAsBytes(@Nonnull
                        Charset aCharset)

getPlane

public int getPlane()

Plane 0 (0000–FFFF): Basic Multilingual Plane (BMP). This is the plane containing most of the character assignments so far. A primary objective for the BMP is to support the unification of prior character sets as well as characters for writing systems in current use. Plane 1 (10000–1FFFF): Supplementary Multilingual Plane (SMP). Plane 2 (20000–2FFFF): Supplementary Ideographic Plane (SIP) Planes 3 to 13 (30000–DFFFF) are unassigned Plane 14 (E0000–EFFFF): Supplementary Special-purpose Plane (SSP) Plane 15 (F0000–FFFFF) reserved for the Private Use Area (PUA) Plane 16 (100000–10FFFF), reserved for the Private Use Area (PUA)

next

@Nonnull
public Codepoint next()

Get the next codepoint

previous

@Nonnull
public Codepoint previous()

Get the previous codepoint

compareTo

public int compareTo(@Nonnull
            Codepoint o)

Specified by:

compareTo in interface Comparable<Codepoint>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object