ch.aplu.tcp

Class TcpTools

java.lang.Object

ch.aplu.tcp.TcpTools

public class TcpTools
extends java.lang.Object

Declaration of some useful static helper methods.

Method Summary

Methods

Modifier and Type	Method and Description
static void	delay(long delayTime) Halts the current thread for the given amount of time (in ms)
static java.lang.String	intAryToString(int[] ary) Converts an integer array to a string to restore string data transmitted over a TcpBridge, TcpAgent link.
static java.lang.String	intAryToString(int[] ary, int beginIndex) Converts an integer array to a string to restore string data transmitted over a TcpBridge, TcpAgent link.
static java.lang.String	intAryToString(int[] ary, int beginIndex, int endIndex) Converts an integer array to a string to restore string data transmitted over a TcpBridge, TcpAgent link.
static java.lang.String[]	split(java.lang.String s, java.lang.String separator) Splits given string with given separator string into multiple strings.
static double[]	splitToDoubleAry(java.lang.String s, java.lang.String separator) Splits a line with concatenated doubles separated by the given separator into single integer values.
static int[]	splitToIntAry(java.lang.String s, java.lang.String separator) Splits a line with concatenated integers separated by the given separator into single integer values.
static int[]	stringToIntAry(java.lang.String s) Converts a string to an integer array that can be used for transmission over a TcpBridge, TcpAgent link.
static java.lang.String	stripNickname(java.lang.String nickname) Returns a nickname where the trailing (n) is removed.
static java.lang.String	stripNickname(java.lang.String nickname, boolean zeroOnly) Returns a nickname where the trailing (n) is removed.
static int[]	toIntAry(long n) Splits the given long (64 bits) into two integers (low-order 32 bits, high-order 32 bits).
static long	toLong(int low, int high) Merges the two given integers (low-order 32 bits, high-order 32 bits) to a long (64 bits).

Methods inherited from class java.lang.Object

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

Method Detail

splitToIntAry

public static int[] splitToIntAry(java.lang.String s,
                  java.lang.String separator)

Splits a line with concatenated integers separated by the given separator into single integer values.

Parameters:

s - the string to split. A separator may or may not end the string

separator - the separator used in between each integer

Returns:

a integer array for each integer value, Integer.MIN_VALUE if the string representation could not be converted into an integer; null, if s is null or empty

splitToDoubleAry

public static double[] splitToDoubleAry(java.lang.String s,
                        java.lang.String separator)

Splits a line with concatenated doubles separated by the given separator into single integer values.

Parameters:

s - the string to split. A separator may or may not end the string

separator - the separator used in between each double

Returns:

a integer array for each integer value, Double.MIN_VALUE if the string representation could not be converted into a double; null, if s is null or empty

split

public static java.lang.String[] split(java.lang.String s,
                       java.lang.String separator)

Splits given string with given separator string into multiple strings. Returns splitted string array (without separator).
Returned array has length 0, if input string or separator is null or empty.
A trailing separator is stripped.

stringToIntAry

public static int[] stringToIntAry(java.lang.String s)

Converts a string to an integer array that can be used for transmission over a TcpBridge, TcpAgent link.

Parameters:

s - the string to convert

Returns:

an integer array with the character values of the string elements

intAryToString

public static java.lang.String intAryToString(int[] ary)

Converts an integer array to a string to restore string data transmitted over a TcpBridge, TcpAgent link.

Parameters:

ary - the integer array with the character values of a string

Returns:

a string that is represented by the given array

intAryToString

public static java.lang.String intAryToString(int[] ary,
                              int beginIndex)

Converts an integer array to a string to restore string data transmitted over a TcpBridge, TcpAgent link.

Parameters:

ary - the integer array with the character values of a string starting at the given index

beginIndex - the index of the the given integer array where the string representation starts

Returns:

a string that is represented by a part of the given array

intAryToString

public static java.lang.String intAryToString(int[] ary,
                              int beginIndex,
                              int endIndex)

Converts an integer array to a string to restore string data transmitted over a TcpBridge, TcpAgent link.

Parameters:

ary - the integer array with the character values of a string starting at the given index and ending at endIndex - 1

beginIndex - the index of an element of the the given integer array where the string representation starts

endIndex - the index of one element behind the end of the string represenation

Returns:

a string that is represented by a part of the given array

stripNickname

public static java.lang.String stripNickname(java.lang.String nickname)

Returns a nickname where the trailing (n) is removed. If a trailing (n) is not found, returns the unchanged nickname.

Parameters:

nickname - the nickname to strip

Returns:

the nickname without any trailing (n)

stripNickname

public static java.lang.String stripNickname(java.lang.String nickname,
                             boolean zeroOnly)

Returns a nickname where the trailing (n) is removed. If a trailing (n) is not found, returns the unchanged nickname.

Parameters:

nickname - the nickname to strip

zeroOnly - if true, only (0) is stripped

Returns:

the nickname without any trailing (n)

delay

public static void delay(long delayTime)

Halts the current thread for the given amount of time (in ms)

Parameters:

delayTime - the time to sleep

toIntAry

public static int[] toIntAry(long n)

Splits the given long (64 bits) into two integers (low-order 32 bits, high-order 32 bits). Useful to split a clock time to an integer array for a bridge-agent transmission.

Parameters:

n - the long to split

Returns:

an integer array in low-order/high-order of the given long

toLong

public static long toLong(int low,
          int high)

Merges the two given integers (low-order 32 bits, high-order 32 bits) to a long (64 bits). Useful to reassemble a clock time transmitted over a bridge-agent connection.

Parameters:

low - the low 32-bit part of the long

high - the high 32-bit part of the long

Returns:

the merged long