com.asakusafw.runtime.value

Class StringOptionUtil

java.lang.Object

com.asakusafw.runtime.value.StringOptionUtil

public final class StringOptionUtil
extends Object

Utilities for StringOption.

Since:

0.8.0

Version:

0.10.3

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	ENCODING The internal text encoding.

Method Summary

Modifier and Type	Method and Description
static void	append(CharBuffer source, StringOption destination, CharsetEncoder encoder, ByteBuffer buffer) Appends source contents into the destination string.
static void	append(StringBuilder target, StringOption contents) Appends the text in the given StringOption into the StringBuilder.
static void	append(StringOption target, String contents) Appends the text in the second StringOption into the first one.
static void	append(StringOption target, StringOption contents) Appends the text in the second StringOption into the first one.
static Reader	asReader(StringOption option) Returns a Reader to read the text contents in the StringOption.
static int	countCodePoints(StringOption option) Returns the number of code-points in the given StringOption.
static BigDecimal	parseDecimal(StringOption contents) Parses the given StringOption which may represent a decimal value.
static int	parseInt(StringOption contents) Parses the given StringOption which may represent a int value.
static long	parseLong(StringOption contents) Parses the given StringOption which may represent a long value.
static void	trim(StringOption option) Trims the leading/trailing classical whitespace characters in the StringOption.

Methods inherited from class java.lang.Object

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

Field Detail

ENCODING

public static final Charset ENCODING

The internal text encoding.

Method Detail

countCodePoints

public static int countCodePoints(StringOption option)

Returns the number of code-points in the given StringOption. If the object does represent neither null nor a valid character string, this operation may raise an error or return a wrong count.

Parameters:

option - the target object

Returns:

the number of code-points in this object, or 0 if the object represents null

Throws:

NullPointerException - if the StringOption is/represents null

Since:

0.9.1

asReader

public static Reader asReader(StringOption option)

Returns a Reader to read the text contents in the StringOption.

Parameters:

option - the target StringOption

Returns:

the created reader

Throws:

NullPointerException - if the StringOption is/represents null

trim

public static void trim(StringOption option)

Trims the leading/trailing classical whitespace characters in the StringOption. This only removes the following characters:

• "\t" (HT:U+0009)
• "\n" (LF:U+000a)
• "\r" (CR:U+000d)
• " " (SP:U+0020)

This directly modifies the target StringOption.

Parameters:

option - the target StringOption

Throws:

NullPointerException - if the StringOption is/represents null

append

public static void append(StringOption target,
                          StringOption contents)

Appends the text in the second StringOption into the first one. This directly modifies the first StringOption.

Parameters:

target - the append target

contents - the text contents to be appended

Throws:

NullPointerException - if the StringOption is/represents null

append

public static void append(StringOption target,
                          String contents)

Appends the text in the second StringOption into the first one. This directly modifies the first StringOption.

Parameters:

target - the append target

contents - the text contents to be appended

Throws:

NullPointerException - if the StringOption is/represents null

append

public static void append(StringBuilder target,
                          StringOption contents)

Appends the text in the given StringOption into the StringBuilder.

Parameters:

target - the append target

contents - the text contents to be appended

Throws:

NullPointerException - if the StringOption is/represents null

Since:

0.9.1

parseInt

public static int parseInt(StringOption contents)

Parses the given StringOption which may represent a int value.

Parameters:

contents - the text contents

Returns:

the parsed value

Throws:

NullPointerException - if the StringOption is/represents null

IllegalArgumentException - if the character sequence is wrong

Since:

0.9.1

parseLong

public static long parseLong(StringOption contents)

Parses the given StringOption which may represent a long value.

Parameters:

contents - the text contents

Returns:

the parsed value

Throws:

NullPointerException - if the StringOption is/represents null

IllegalArgumentException - if the character sequence is wrong

Since:

0.9.1

parseDecimal

public static BigDecimal parseDecimal(StringOption contents)

Parses the given StringOption which may represent a decimal value.

Parameters:

contents - the text contents

Returns:

the parsed decimal value

Throws:

NullPointerException - if the StringOption is/represents null

IllegalArgumentException - if the character sequence is wrong

Since:

0.9.1

append

public static void append(CharBuffer source,
                          StringOption destination,
                          CharsetEncoder encoder,
                          ByteBuffer buffer)
                   throws CharacterCodingException

Appends source contents into the destination string.

Parameters:

source - the source buffer

destination - the target StringOption

encoder - the encoder

buffer - the working buffer

Throws:

CharacterCodingException - if error occurred while encoding source input

Since:

0.10.3