net.pandoragames.far.ui.model

Class CharacterUtil

java.lang.Object

net.pandoragames.far.ui.model.CharacterUtil

public class CharacterUtil
extends java.lang.Object

Static helper for character handling routines.

Author:

Olivier Wehner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CharacterUtil.LineCount Number of lines and line separator (break character) in one box.

Constructor Summary

Constructors

Constructor and Description
CharacterUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static int	countLinebreaks(char[] buffer, int offset, int length) Returns the number of line breaks (\n, \r or combination thereof) found in the specified buffer.
static CharacterUtil.LineCount	countLinebreaks(java.io.InputStream instream) Returns the number of lines (\n, \r or combination thereof) found in the specified input and its type.
static java.lang.String	flatWhiteSpace(java.lang.String raw) Replaces every sequence of whitespace characters with a single blank (" ").
static java.nio.charset.Charset[]	getCharsetList(java.util.List<java.nio.charset.Charset> availableCharsets, java.nio.charset.Charset actualCharset) Returns the supplied List as an array, and guarantees that the specified actual Charset is contained.
static boolean	isLineBreakChar(char c) Returns true if the specified character is a linefeed (LF) or a carriage return (CR).
static void	reportIllegalCharacter(char[] text, int offset, int length, java.nio.charset.CharsetEncoder encoder, int firstLine, MessageBox messageBox, Localizer localizer) Find the position of the first illegal character for the present encoding (if any) and write a suitable message to the message sink.

Methods inherited from class java.lang.Object

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

Constructor Detail

CharacterUtil

public CharacterUtil()

Method Detail

countLinebreaks

public static int countLinebreaks(char[] buffer,
                  int offset,
                  int length)

Returns the number of line breaks (\n, \r or combination thereof) found in the specified buffer.

Parameters:

buffer - where to look

offset - where to start looking

length - how many characters to test

Returns:

number of line breaks found, counting \n\r (and \r\n) as a single linebreak

countLinebreaks

public static CharacterUtil.LineCount countLinebreaks(java.io.InputStream instream)
                                               throws java.io.IOException

Returns the number of lines (\n, \r or combination thereof) found in the specified input and its type.

Parameters:

instream - where to look

Returns:

number of line breaks found, counting \r\n (and \n\r) as a single linebreak

Throws:

java.io.IOException - if the stream throws one

reportIllegalCharacter

public static void reportIllegalCharacter(char[] text,
                          int offset,
                          int length,
                          java.nio.charset.CharsetEncoder encoder,
                          int firstLine,
                          MessageBox messageBox,
                          Localizer localizer)

Find the position of the first illegal character for the present encoding (if any) and write a suitable message to the message sink.

Parameters:

text - to be scanned for illegal characters

offset - where to start scanning

length - how many characters to scan

encoder - encoder to be used for testing

firstLine - number of first line

messageBox - where to write the message to

localizer - to be used for translations

flatWhiteSpace

public static java.lang.String flatWhiteSpace(java.lang.String raw)

Replaces every sequence of whitespace characters with a single blank (" ").

Parameters:

raw - to be flattend

Returns:

raw string with linebreaks, tabs and ws sequeces transformed to single blank

isLineBreakChar

public static boolean isLineBreakChar(char c)

Returns true if the specified character is a linefeed (LF) or a carriage return (CR).

Parameters:

c - to be tested

Returns:

true if LF or CR

getCharsetList

public static java.nio.charset.Charset[] getCharsetList(java.util.List<java.nio.charset.Charset> availableCharsets,
                                        java.nio.charset.Charset actualCharset)

Returns the supplied List as an array, and guarantees that the specified actual Charset is contained.

Parameters:

availableCharsets - list to be returned as array, actual Charset included

actualCharset - the one charset that must be included in the list

Returns:

charset list as array with actual charset included