triana.types.util

Class Str

java.lang.Object

triana.types.util.Str

public final class Str
extends java.lang.Object

Str is a class which contains static functions which perform a number of useful repetitive function in java. e.g. when converting from a String to a float, you just simply type in :-

myfloat = Str.strToFloat(str);
instead of
myfloat = Float.valueOf(str).floatValue();

The latter, I find really annoying! The routines here therefore colate a number of frequently performed procedures and provide shortcuts to their operation.

Also, there are routines for counting the line numbers and finding and replacing etc.

Constructor Summary

Constructors

Constructor and Description
Str()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	copy(java.lang.String s) Copies a String, not by reference
static int	howMany() gets number of replacings made by the replaceAll function.
static java.lang.String	insertString(java.lang.String theString, int pos, java.lang.String text) Inserts a String into a given String at a given position.
static java.lang.String	niceDate(java.util.Date d)
static java.lang.String	niceDateAndTime(java.util.Date d)
static int	noLineChars(java.lang.String str, int pos) From the specified position in the String this function returns the number of characters excluding line feeds for this position.
static void	printHashtable(java.util.Hashtable v, java.io.PrintWriter pw) For printing out the types and associated colours to the user configuration file.
static void	printTreeMap(java.util.TreeMap v, java.io.PrintWriter pw) For printing out the types and associated colours to the user configuration file.
static void	printVector(java.util.Vector v, java.io.PrintWriter pw) Prints a vector one element after another with a new line between each element.
java.lang.String	removeSubstring(java.lang.String theString, int from, int to) Removes a substring from the given String and returns a String consisting of the remaining parts concatenated.
static java.lang.String	replaceAll(java.lang.String theString, java.lang.String text, java.lang.String newText) Replace all occurances of text with newText from theString.
static java.lang.String	replaceNext(java.lang.String theString, int pos, java.lang.String text, java.lang.String newText) Starting at the given position, this method finds the next occurence of the given string text from the string theString and replaces it with the newText.
static java.lang.String	replaceNext(java.lang.String theString, java.lang.String text, java.lang.String newText) Finds the next occurence of the given string text from the string theString and replaces it with the newText.
static StringVector	splitText(java.lang.String text) This function splits the text into a vector of lines contained within that text i.e.
static StringVector	splitTextBySpace(java.lang.String text) Splits the text by items separated by white space
static boolean	strToBoolean(java.lang.String str) Attempts to convert a String to a boolean
static byte	strToByte(java.lang.String str) Attempts to convert a String to a byte
static double	strToDouble(java.lang.String str) Attempts to convert a String to a double
static float	strToFloat(java.lang.String str) Attempts to convert a String to a float
static int	strToInt(java.lang.String str) Attempts to convert a String to an int
static long	strToLong(java.lang.String str) Attempts to convert a String to a long
static short	strToShort(java.lang.String str) Attempts to convert a String to a short

Methods inherited from class java.lang.Object

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

Constructor Detail

Str

public Str()

Method Detail

copy

public static java.lang.String copy(java.lang.String s)

Copies a String, not by reference

strToFloat

public static float strToFloat(java.lang.String str)
                        throws java.lang.NumberFormatException,
                               java.lang.NullPointerException

Attempts to convert a String to a float

Throws:

java.lang.NumberFormatException

java.lang.NullPointerException

strToDouble

public static double strToDouble(java.lang.String str)
                          throws java.lang.NumberFormatException,
                                 java.lang.NullPointerException

Attempts to convert a String to a double

Throws:

java.lang.NumberFormatException

java.lang.NullPointerException

strToInt

public static int strToInt(java.lang.String str)
                    throws java.lang.NumberFormatException,
                           java.lang.NullPointerException

Attempts to convert a String to an int

Throws:

java.lang.NumberFormatException

java.lang.NullPointerException

strToShort

public static short strToShort(java.lang.String str)
                        throws java.lang.NumberFormatException,
                               java.lang.NullPointerException

Attempts to convert a String to a short

Throws:

java.lang.NumberFormatException

java.lang.NullPointerException

strToLong

public static long strToLong(java.lang.String str)
                      throws java.lang.NumberFormatException,
                             java.lang.NullPointerException

Attempts to convert a String to a long

Throws:

java.lang.NumberFormatException

java.lang.NullPointerException

strToByte

public static byte strToByte(java.lang.String str)
                      throws java.lang.NumberFormatException,
                             java.lang.NullPointerException

Attempts to convert a String to a byte

Throws:

java.lang.NumberFormatException

java.lang.NullPointerException

strToBoolean

public static boolean strToBoolean(java.lang.String str)
                            throws java.lang.NumberFormatException,
                                   java.lang.NullPointerException

Attempts to convert a String to a boolean

Throws:

java.lang.NumberFormatException

java.lang.NullPointerException

niceDate

public static final java.lang.String niceDate(java.util.Date d)

Returns:

a "19 Mar 1997" type format of the date. Gets rid of the time etc.

niceDateAndTime

public static final java.lang.String niceDateAndTime(java.util.Date d)

Returns:

a "19 Mar 1997" type format of the date. Gets rid of the time etc. Give new Date() as argument if the current time and date is needed.

replaceNext

public static java.lang.String replaceNext(java.lang.String theString,
                           java.lang.String text,
                           java.lang.String newText)

Finds the next occurence of the given string text from the string theString and replaces it with the newText. This should be used with caution: it uses a counter to keep track of how many occurences there have been, but this counter will be advanced by any call to this method, even one that searches a different String. It is safer to use the version with the position argument and keep track of the position in the calling program.

Parameters:

theString - the String to scan

text - the text to find within theString

newText - the String to replace text with

Returns:

the String after replacement

replaceNext

public static java.lang.String replaceNext(java.lang.String theString,
                           int pos,
                           java.lang.String text,
                           java.lang.String newText)

Starting at the given position, this method finds the next occurence of the given string text from the string theString and replaces it with the newText.

Parameters:

theString - the String to scan

pos - the starting index within the given string

text - the text to find within theString

newText - the String to replace text with

Returns:

the String after replacement

insertString

public static java.lang.String insertString(java.lang.String theString,
                            int pos,
                            java.lang.String text)

Inserts a String into a given String at a given position. The insertion is made so that the first character of the inserted String will be at the given position in the returned String. If the given position is not within the initial String (negative or too large) then the original String is return without modification.

Parameters:

theString - The String to be modified

pos - The index at which the insertion is to be made

text - The insertion String

Returns:

The modified String

removeSubstring

public java.lang.String removeSubstring(java.lang.String theString,
                               int from,
                               int to)

Removes a substring from the given String and returns a String consisting of the remaining parts concatenated.

Parameters:

theString - The String to be modified

from - The index of the first character to be removed

to - The index of the first character that remains after the removed String

Returns:

The modified String

replaceAll

public static java.lang.String replaceAll(java.lang.String theString,
                          java.lang.String text,
                          java.lang.String newText)

Replace all occurances of text with newText from theString.

Parameters:

theString - the string to scan

text - the text to find within theString

newText - the string to replace text with

Returns:

the new String after all the relevant text has been replaced

noLineChars

public static int noLineChars(java.lang.String str,
              int pos)

From the specified position in the String this function returns the number of characters excluding line feeds for this position. JTextAreas don't seem to use line feeds for example.

howMany

public static int howMany()

gets number of replacings made by the replaceAll function.

splitTextBySpace

public static StringVector splitTextBySpace(java.lang.String text)

Splits the text by items separated by white space

splitText

public static StringVector splitText(java.lang.String text)

This function splits the text into a vector of lines contained within that text i.e. splits the text on the newline character.

printVector

public static void printVector(java.util.Vector v,
               java.io.PrintWriter pw)

Prints a vector one element after another with a new line between each element.

printHashtable

public static void printHashtable(java.util.Hashtable v,
                  java.io.PrintWriter pw)

For printing out the types and associated colours to the user configuration file. Can be also used to print out any hashtable objects in a :-

colorname actualcolor

format

printTreeMap

public static void printTreeMap(java.util.TreeMap v,
                java.io.PrintWriter pw)

For printing out the types and associated colours to the user configuration file. Can be also used to print out any hashtable objects in a :-

colorname actualcolor

format