org.kocakosm.pitaya.charset

Class ASCII

java.lang.Object

org.kocakosm.pitaya.charset.ASCII

public final class ASCII
extends Object

Static utility methods that operate on or return ASCII chars and Strings.

Author:

Osman KOCAK

Method Summary

Modifier and Type	Method and Description
static boolean	canDecode(byte... input) Returns whether the given byte array represents valid ASCII encoded characters.
static boolean	canDecode(byte[] input, int off, int len) Returns whether the specified range in the given byte array represents valid ASCII encoded characters.
static boolean	canEncode(String str) Returns whether the given String can be encoded into ASCII.
static boolean	canEncode(String str, int off, int len) Returns whether the specified range in the given String can be encoded into ASCII.
static String	capitalize(String str) Returns a String built from the given one by upper-casing its first character (other characters are copied unchanged).
static String	decode(byte... input) Decodes the given ASCII encoded characters.
static String	decode(byte[] input, int off, int len) Decodes len ASCII encoded bytes from the given input buffer, starting at off.
static byte[]	encode(String str) Returns the ASCII encoding of the given String.
static byte[]	encode(String str, int off, int len) Returns the ASCII encoding of the specified character sequence.
static boolean	isAlphabetic(String str) Returns whether the given String is an alphabetic sequence, that is, a sequence which only contains letters.
static boolean	isAlphaNumeric(String str) Returns whether the given String is an alphanumeric sequence, that is, a sequence which only contains letters and digits.
static boolean	isDigit(char c) Returns whether the given character represents a digit.
static boolean	isLetter(char c) Returns whether the given character is a letter.
static boolean	isLowerCase(char c) Returns whether the given character is one of the lowercase ASCII characters between 'a' and 'z' (inclusive).
static boolean	isNumeric(String str) Returns whether the given String is a numeric sequence, that is, a sequence which only contains digits.
static boolean	isUpperCase(char c) Returns whether the given character is one of the uppercase ASCII characters between 'A' and 'Z' (inclusive).
static char	toLowerCase(char c) Returns the lowercase equivalent of the given character.
static String	toLowerCase(String str) Returns a String in which all uppercase ASCII characters have been replaced by their lowercase equivalent (all other characters are unchanged).
static char	toUpperCase(char c) Returns the uppercase equivalent of the given character.
static String	toUpperCase(String str) Returns a String in which all lowercase ASCII characters have been replaced by their uppercase equivalent (all other characters are unchanged).

Methods inherited from class java.lang.Object

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

Method Detail

canEncode

public static boolean canEncode(String str)

Returns whether the given String can be encoded into ASCII.

Parameters:

str - the String to test.

Returns:

whether str can be encoded into ASCII.

Throws:

NullPointerException - if str is null.

canEncode

public static boolean canEncode(String str,
                                int off,
                                int len)

Returns whether the specified range in the given String can be encoded into ASCII.

Parameters:

str - the input String.

off - the start index, inclusive.

len - the number of characters to test.

Returns:

whether the specified range in str can be encoded into ASCII.

Throws:

NullPointerException - if str is null.

IndexOutOfBoundsException - if off or len is negative or if off + len is greater than str's length.

canDecode

public static boolean canDecode(byte... input)

Returns whether the given byte array represents valid ASCII encoded characters.

Parameters:

input - the bytes to test.

Returns:

whether input repesents ASCII encoded characters.

Throws:

NullPointerException - if input is null.

canDecode

public static boolean canDecode(byte[] input,
                                int off,
                                int len)

Returns whether the specified range in the given byte array represents valid ASCII encoded characters.

Parameters:

input - the input buffer.

off - the start index, inclusive.

len - the number of bytes to test.

Returns:

whether the specified range in input represents ASCII encoded characters.

Throws:

NullPointerException - if input is null.

IndexOutOfBoundsException - if off or len is negative or if off + len is greater than input's length.

encode

public static byte[] encode(String str)

Returns the ASCII encoding of the given String.

Parameters:

str - the String to encode.

Returns:

the ASCII encoding of the given String.

Throws:

NullPointerException - if str is null.

IllegalArgumentException - if str can't be encoded into ASCII.

encode

public static byte[] encode(String str,
                            int off,
                            int len)

Returns the ASCII encoding of the specified character sequence.

Parameters:

str - the input String.

off - the start index, inclusive.

len - the number of characters to encode.

Returns:

the ASCII encoding of the specified characters.

Throws:

NullPointerException - if str is null.

IndexOutOfBoundsException - if off or len is negative or if off + len is greater than str's length.

IllegalArgumentException - if the specified characters can't be encoded into ASCII.

decode

public static String decode(byte... input)

Decodes the given ASCII encoded characters.

Parameters:

input - the ASCII encoded characters to decode.

Returns:

the decoded characters.

Throws:

NullPointerException - if input is null.

IllegalArgumentException - if input doesn't represent valid ASCII encoded characters.

decode

public static String decode(byte[] input,
                            int off,
                            int len)

Decodes len ASCII encoded bytes from the given input buffer, starting at off.

Parameters:

input - the input buffer.

off - the starting offset.

len - the number of bytes to decode.

Returns:

the decoded characters.

Throws:

NullPointerException - if input is null.

IndexOutOfBoundsException - if off or len is negative or if off + len is greater than input's length.

IllegalArgumentException - if the specified bytes do not represent valid ASCII encoded characters.

isDigit

public static boolean isDigit(char c)

Returns whether the given character represents a digit.

Parameters:

c - the character to test.

Returns:

whether the given character represents a digit.

isLetter

public static boolean isLetter(char c)

Returns whether the given character is a letter.

Parameters:

c - the character to test.

Returns:

whether the given character is a letter.

isAlphabetic

public static boolean isAlphabetic(String str)

Returns whether the given String is an alphabetic sequence, that is, a sequence which only contains letters.

Parameters:

str - the String to test.

Returns:

whether the given String is an alphabetic sequence.

Throws:

NullPointerException - if str is null.

isNumeric

public static boolean isNumeric(String str)

Returns whether the given String is a numeric sequence, that is, a sequence which only contains digits.

Parameters:

str - the String to test.

Returns:

whether the given String is a numeric sequence.

Throws:

NullPointerException - if str is null.

isAlphaNumeric

public static boolean isAlphaNumeric(String str)

Returns whether the given String is an alphanumeric sequence, that is, a sequence which only contains letters and digits.

Parameters:

str - the String to test.

Returns:

whether the given String is an alphanumeric sequence.

Throws:

NullPointerException - if str is null.

isLowerCase

public static boolean isLowerCase(char c)

Returns whether the given character is one of the lowercase ASCII characters between 'a' and 'z' (inclusive). All others return false.

Parameters:

c - the character to test.

Returns:

whether the given character is a lowercase character.

isUpperCase

public static boolean isUpperCase(char c)

Returns whether the given character is one of the uppercase ASCII characters between 'A' and 'Z' (inclusive). All others return false.

Parameters:

c - the character to test.

Returns:

whether the given character is a uppercase character.

toLowerCase

public static char toLowerCase(char c)

Returns the lowercase equivalent of the given character. If the given character doesn't represent an uppercase ASCII character, this method simply returns the given argument.

Parameters:

c - the character to transform lowercase.

Returns:

the lowercase equivalent of the given character if it is an uppercase one, or the argument itself otherwise.

toUpperCase

public static char toUpperCase(char c)

Returns the uppercase equivalent of the given character. If the given character doesn't represent a lowercase ASCII character, this method simply returns the given argument.

Parameters:

c - the character to transform uppercase.

Returns:

the uppercase equivalent of the given character if it is a lowercase one, or the argument itself otherwise.

toLowerCase

public static String toLowerCase(String str)

Returns a String in which all uppercase ASCII characters have been replaced by their lowercase equivalent (all other characters are unchanged).

Parameters:

str - the String to convert into lowercase.

Returns:

the converted String.

Throws:

NullPointerException - if str is null.

toUpperCase

public static String toUpperCase(String str)

Returns a String in which all lowercase ASCII characters have been replaced by their uppercase equivalent (all other characters are unchanged).

Parameters:

str - the String to convert into uppercase.

Returns:

the converted String.

Throws:

NullPointerException - if str is null.

capitalize

public static String capitalize(String str)

Returns a String built from the given one by upper-casing its first character (other characters are copied unchanged).

Parameters:

str - the String to capitalize.

Returns:

the capitalized String.

Throws:

NullPointerException - if str is null.