org.refcodes.textual.utils

Class AlignTextUtility

java.lang.Object

org.refcodes.textual.utils.AlignTextUtility

public class AlignTextUtility
extends Object

Author:

steiner

Method Summary

Modifier and Type	Method and Description
static void	doStrip(StringBuffer aStringBuffer, char aChar) Removes all leading and trailing chars identical with specified char ch.
static void	doStripLeft(StringBuffer aStringBuffer, char aChar) Removes all leading chars identical with specified char ch.
static void	doStripRight(StringBuffer aStringBuffer, char aChar) Removes all rear chars identical with specified char ch.
static String[]	toAlign(String[] aText, int aLength, char aFillChar, TextAlignMode aTextAlignMode)
static String	toAlign(String aText, int aLength, char aFillChar, TextAlignMode aTextAlignMode) Fills a text up on by appending the given char to the left and the right till the given length is reached.
static String[]	toAlignBlock(String[] aText, int aLength, char aFillChar)
static String	toAlignBlock(String aText, int aLength, char aFillChar) Fills a text up on by adding the given char to occurrences of the given char round robin till given length is reached (block mode).
static String[]	toAlignCenter(String[] aText, int aLength, char aFillChar)
static String	toAlignCenter(String aText, int aLength, char aFillChar) Fills a text up on by appending the given char to the left and the right till the given length is reached (align center).
static String[]	toAlignLeft(String[] aText, int aLength, char aFillChar)
static String	toAlignLeft(String aText, int aLength, char aFillChar) Fills a text up on by appending the given char to the right till the given length is reached (align left).
static String[]	toAlignRight(String[] aText, int aLength, char aFillChar)
static String	toAlignRight(String aText, int aLength, char aFillChar) Fills a text up by prepending the given char to the left till the given length is reached (align right).
static String	toOverwriteLeft(String aText, String aWriteOverText) Overwrites a text starting at the left hand side with the given "overwriting" text.
static String	toOverwriteRight(String aText, String aWriteOverText) Overwrites a text starting at the right hand side with the given "overwriting" text.
static String	toStrip(String aText, char[] aChars) Returns a new String without leading nor trailing chars.
static String	toStripLeft(String aText, char[] aChars) Returns a new String without leading chars.
static String	toStripRight(String aText, char[] aChars) Returns a new String without trailing chars.

Methods inherited from class java.lang.Object

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

Method Detail

toAlign

public static String toAlign(String aText,
                             int aLength,
                             char aFillChar,
                             TextAlignMode aTextAlignMode)

Fills a text up on by appending the given char to the left and the right till the given length is reached.

Parameters:

aText - The text to be filled up or aligned.

aLength - The length to be reached.

aFillChar - The char to be used for filling up

Returns:

A String filled up with the given char till the width is reached or the String untouched in case no TextAlignMode parameter has been provided..

toAlign

public static String[] toAlign(String[] aText,
                               int aLength,
                               char aFillChar,
                               TextAlignMode aTextAlignMode)

See Also:

except applied to {@link String} arrays.

toAlignLeft

public static String toAlignLeft(String aText,
                                 int aLength,
                                 char aFillChar)

Fills a text up on by appending the given char to the right till the given length is reached (align left).

Parameters:

aText - The text to be filled up.

aLength - The length to be reached.

aFillChar - The char to be used for filling up

Returns:

A String filled up on the right hand side with the given char.

toAlignLeft

public static String[] toAlignLeft(String[] aText,
                                   int aLength,
                                   char aFillChar)

See Also:

except applied to {@link String} arrays.

toAlignRight

public static String toAlignRight(String aText,
                                  int aLength,
                                  char aFillChar)

Fills a text up by prepending the given char to the left till the given length is reached (align right).

Parameters:

aText - The text to be filled up.

aLength - The length to be reached.

aFillChar - The char to be used for filling up

Returns:

A String filled up on the left hand side with the given char.

toAlignRight

public static String[] toAlignRight(String[] aText,
                                    int aLength,
                                    char aFillChar)

See Also:

except applied to {@link String} arrays.

toAlignCenter

public static String toAlignCenter(String aText,
                                   int aLength,
                                   char aFillChar)

Fills a text up on by appending the given char to the left and the right till the given length is reached (align center).

Parameters:

aText - The text to be filled up.

aLength - The length to be reached.

aFillChar - The char to be used for filling up

Returns:

A String filled up on the left and right hand side with the given char.

toAlignCenter

public static String[] toAlignCenter(String[] aText,
                                     int aLength,
                                     char aFillChar)

See Also:

except applied to {@link String} arrays.

toAlignBlock

public static String toAlignBlock(String aText,
                                  int aLength,
                                  char aFillChar)

Fills a text up on by adding the given char to occurrences of the given char round robin till given length is reached (block mode).

Parameters:

aText - The text to be filled up.

aLength - The length to be reached.

aFillChar - The char to be used for filling up

Returns:

A String filled up in block mode with the given char.

toAlignBlock

public static String[] toAlignBlock(String[] aText,
                                    int aLength,
                                    char aFillChar)

See Also:

except applied to {@link String} arrays.

toOverwriteLeft

public static String toOverwriteLeft(String aText,
                                     String aWriteOverText)

Overwrites a text starting at the left hand side with the given "overwriting" text.

Parameters:

aText - The text to be overwritten.

aWriteOverText - The text used for overwriting.

Returns:

A String overwritten on the left hand side with the given "overwriting" text.

toOverwriteRight

public static String toOverwriteRight(String aText,
                                      String aWriteOverText)

Overwrites a text starting at the right hand side with the given "overwriting" text.

Parameters:

aText - The text to be overwritten.

aWriteOverText - The text used for overwriting.

Returns:

A String overwritten on the right hand side with the given "overwriting" text.

doStripLeft

public static void doStripLeft(StringBuffer aStringBuffer,
                               char aChar)

Removes all leading chars identical with specified char ch. E.g. if str=AAABBBAAABBB and ch=A the returned String will be BBBAAABBB.

Parameters:

aStringBuffer - StringBuffer to modify.

aChar - Char to remove.

toStripLeft

public static String toStripLeft(String aText,
                                 char[] aChars)

Returns a new String without leading chars.

Parameters:

aText - The text to be stripped.

Returns:

The stripped text.

doStripRight

public static void doStripRight(StringBuffer aStringBuffer,
                                char aChar)

Removes all rear chars identical with specified char ch. E.g. if str=AAABBBAAABBB and ch=B str will become AAABBBAAA.

Parameters:

aStringBuffer - StringBuffer to modify.

aChar - Char to remove.

doStrip

public static void doStrip(StringBuffer aStringBuffer,
                           char aChar)

Removes all leading and trailing chars identical with specified char ch. E.g. if str=BAABBBAAABBB and ch=B str will become AABBBAAA.

Parameters:

aStringBuffer - StringBuffer to modify.

aChar - Char to remove.

toStripRight

public static String toStripRight(String aText,
                                  char[] aChars)

Returns a new String without trailing chars.

Parameters:

aText - Description is currently not available!

Returns:

Description is currently not available!

toStrip

public static String toStrip(String aText,
                             char[] aChars)

Returns a new String without leading nor trailing chars.

Parameters:

aText - The text to be stripped.

Returns:

The stripped text.