net.morimekta.console.chr

Class Unicode

java.lang.Object

net.morimekta.console.chr.Unicode

All Implemented Interfaces:

Comparable<Char>, Char, Numeric, Stringable

public class Unicode
extends Object
implements Char

Unicode character representation. It represent the full 31-but unicode code point, and will expand to the 2 surrogate paired string if necessary.

Field Summary

Fields inherited from interface net.morimekta.console.chr.Char

ABR, BEL, BS, CR, DEL, EOF, ESC, FF, FS, GS, LF, NUL, RS, TAB, US, VT

Constructor Summary

Constructors

Constructor and Description
Unicode(char ch)
Unicode(int cp)

Method Summary

Modifier and Type	Method and Description
int	asInteger() Unicode codepoint representing this character.
String	asString()
int	compareTo(Char o)
boolean	equals(Object o)
int	hashCode()
int	length() Number of utf-16 characters that this character takes up if enclosed in a java string.
static Unicode	makeBorder(int u, int r, int d, int l) Make a uncode boder symbol matching the lines given.
static Unicode	makeNumeric(int num) Gets the unicode char representing a circled number.
int	printableWidth() The number of character spaces taken up by this symbol.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Unicode

public Unicode(int cp)

Unicode

public Unicode(char ch)

Method Detail

asInteger

public int asInteger()

Description copied from interface: Char

Unicode codepoint representing this character.

Specified by:

asInteger in interface Char

Specified by:

asInteger in interface Numeric

Returns:

The 31 bit unsigned unicode code-point, or -1 if not representing a single unicode character.

asString

public String asString()

Specified by:

asString in interface Stringable

printableWidth

public int printableWidth()

Description copied from interface: Char

The number of character spaces taken up by this symbol. Usually 1, but 0 for control sequences, control characters, and 2 for wide symbols like CJK characters.

Specified by:

printableWidth in interface Char

Returns:

The printable width of the character.

length

public int length()

Description copied from interface: Char

Number of utf-16 characters that this character takes up if enclosed in a java string.

Specified by:

length in interface Char

Returns:

The char count of the character.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

makeBorder

public static Unicode makeBorder(int u,
                                 int r,
                                 int d,
                                 int l)

Make a uncode boder symbol matching the lines given. The four valies are for top (upward line), right, bottom and left. 0 - no line. 1 - thin line 2 - thick line 3 - double line

Parameters:

u - The upward line.

r - The rightward line.

d - The downward line.

l - The leftward line.

Returns:

The unicode instance, or null if none matching.

makeNumeric

public static Unicode makeNumeric(int num)

Gets the unicode char representing a circled number.

Parameters:

num - Number to get unicode char for.

Returns:

The unicode char representation.

compareTo

public int compareTo(Char o)

Specified by:

compareTo in interface Comparable<Char>