Codepoint (ph-commons 6.0.1 API)

java.lang.Object
- com.helger.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()`
`char`	`getLowSurrogate()`
`int`	`getPlane()` Plane 0 (0000–FFFF): Basic Multilingual Plane (BMP).
`int`	`getValue()`
`int`	`hashCode()`
`boolean`	`isAlpha()`
`boolean`	`isAlphaDigit()`
`boolean`	`isBidi()`
`boolean`	`isDigit()`
`boolean`	`isHighSurrogate()`
`boolean`	`isLowSurrogate()`
`boolean`	`isSupplementary()`
`Codepoint`	`next()`
`Codepoint`	`previous()`

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
    
    Parameters:
    bytes - Bytes
    encoding - Charset
  - Codepoint
```
public Codepoint(@Nonnull
         CharSequence value)
```
    Create a Codepoint from a CharSequence. Length must equal 1 or 2
    
    Parameters:
    value - CharSequence
  - Codepoint
```
public Codepoint(@Nonnull
         String value)
```
    Create a Codepoint from a String. Length must equal 1 or 2
    
    Parameters:
    value - String
  - Codepoint
```
public Codepoint(@Nonnull
         char[] value)
```
    Create a Codepoint from a char array. Length must equal 1 or 2
    
    Parameters:
    value - char array
  - Codepoint
```
public Codepoint(char value)
```
    Create a codepoint from a single char
    
    Parameters:
    value - single char
  - Codepoint
```
public Codepoint(char high,
         char low)
```
    Create a codepoint from a surrogate pair
    
    Parameters:
    high - high surrogate
    low - low surrogate
  - Codepoint
```
public Codepoint(@Nonnull
         Codepoint aCodepoint)
```
    Create a codepoint as a copy of another codepoint
    
    Parameters:
    aCodepoint - Object to copy
  - Codepoint
```
public Codepoint(@Nonnegative
         int nValue)
```
    Create a codepoint from a specific integer value
    
    Parameters:
    nValue - int value
- Method Detail
  - getValue
```
@Nonnegative
public int getValue()
```
    Returns:
    The codepoint value
  - isSupplementary
```
public boolean isSupplementary()
```
    Returns:
    true if this codepoint is supplementary
  - isLowSurrogate
```
public boolean isLowSurrogate()
```
    Returns:
    true if this codepoint is a low surrogate
  - isHighSurrogate
```
public boolean isHighSurrogate()
```
    Returns:
    true if this codepoint is a high surrogate
  - getHighSurrogate
```
public char getHighSurrogate()
```
    Returns:
    Get the high surrogate of this Codepoint
  - getLowSurrogate
```
public char getLowSurrogate()
```
    Returns:
    Get the low surrogate of this Codepoint
  - isBidi
```
public boolean isBidi()
```
    Returns:
    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)
    
    Returns:
    Plane number
  - next
```
@Nonnull
public Codepoint next()
```
    Returns:
    Get the next codepoint
  - previous
```
@Nonnull
public Codepoint previous()
```
    Returns:
    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

Class Codepoint

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Codepoint

Codepoint

Codepoint

Codepoint

Codepoint

Codepoint

Codepoint

Codepoint

Method Detail

getValue

isSupplementary

isLowSurrogate

isHighSurrogate

getHighSurrogate

getLowSurrogate

isBidi

isDigit

isAlpha

isAlphaDigit

getAsString

getAsChars

getCharCount

getAsBytes

getPlane

next

previous

compareTo

equals

hashCode