org.transitime.utils

Class StringUtils

java.lang.Object

org.transitime.utils.StringUtils

public class StringUtils
extends java.lang.Object

Simple string utilities such as for formating double to desired number of decimal places.

Author:

SkiBu Smith

Constructor Summary

Constructors

Constructor and Description
StringUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	distanceFormat(double distance) Outputs distance string along with units.
static java.lang.String	memoryFormat(long arg) Returns formatted string indicating number of bytes.
static java.lang.String	oneDigitFormat(double arg) For formatting double to 1 decimal place.
static java.lang.String	paddedName(java.lang.String name) Returns the name passed in, but the first number in the name is padded with zeros so that the numbers have the same number of digits.
static java.lang.String	padWithBlanks(java.lang.String original, int desiredCharacters) Returns original string padded with spaces so that it is desiredCharacters long.
static java.lang.String	sixDigitFormat(double arg) For formatting double to 6 decimal places.
static void	sortIds(java.util.List<java.lang.String> ids) Sorts the list of IDs.
static void	sortIdsNumerically(java.util.List<java.lang.String> ids) Sorts the list of IDs.
static java.lang.String	threeDigitFormat(double arg) For formatting double to 3 decimal places.
static java.lang.String	twoDigitFormat(double arg) For formatting double to 2 decimal places.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringUtils

public StringUtils()

Method Detail

memoryFormat

public static java.lang.String memoryFormat(long arg)

Returns formatted string indicating number of bytes. Uses highest possible units, up to 4 digits. will get a result such as 4,231MB

Parameters:

arg -

Returns:

distanceFormat

public static java.lang.String distanceFormat(double distance)

Outputs distance string along with units. If value below 3,000 then uses meters as in 392.2m . If greater than 3,000 then uses km as in 3.1km .

Parameters:

distance -

Returns:

The distance as a string

oneDigitFormat

public static java.lang.String oneDigitFormat(double arg)

For formatting double to 1 decimal place.

Parameters:

arg -

Returns:

the value as a string

twoDigitFormat

public static java.lang.String twoDigitFormat(double arg)

For formatting double to 2 decimal places.

Parameters:

arg -

Returns:

the value as a string

threeDigitFormat

public static java.lang.String threeDigitFormat(double arg)

For formatting double to 3 decimal places.

Parameters:

arg -

Returns:

the value as a string

sixDigitFormat

public static java.lang.String sixDigitFormat(double arg)

For formatting double to 6 decimal places.

Parameters:

arg -

Returns:

the value as a string

padWithBlanks

public static java.lang.String padWithBlanks(java.lang.String original,
                                             int desiredCharacters)

Returns original string padded with spaces so that it is desiredCharacters long. If the original string is already at least as long as desired then it is returned.

Parameters:

original -

desiredCharacters -

Returns:

paddedName

public static java.lang.String paddedName(java.lang.String name)

Returns the name passed in, but the first number in the name is padded with zeros so that the numbers have the same number of digits. This way can sort the names properly even if have names such as Y2 and Y101 (Y2 should be before Y101 even though if used regular string comparison Y101 would be before Y2).

Parameters:

name - The alpha numeric name to be padded.

Returns:

a modified version of the name that can be used for proper ordering of a collection of names. for ordering

sortIdsNumerically

public static void sortIdsNumerically(java.util.List<java.lang.String> ids)

Sorts the list of IDs. Pads the first numeric part of the identifiers when doing the sorting so that numbers will end up in the proper order. This is 10 times slower than sortIds(), but the ordering is much nicer.

Parameters:

ids -

sortIds

public static void sortIds(java.util.List<java.lang.String> ids)

Sorts the list of IDs. Uses a regular string sort. Much faster than sorting IDs numerically because don't need to pad the IDs in order for them to be ordered properly. But then number won't be in the proper order. For example, "10" will end up before "9".

Parameters:

ids - to be sorted