com.raspoid

Class Tools

java.lang.Object

com.raspoid.Tools

public class Tools
extends java.lang.Object

This class contains some utility functions used accross the entire framework.

As an example, our logger system can easily be used to print colored log/debug messages to the standard output:

 Tools.log("Hello world", Tools.Color.ANSI_RED);
 Tools.debug("Hello world", Tools.Color.ANSI_BLUE);
 

You can easily disable thoses logs/debugs with the following static methods:

 Tools.disableLogs();
 Tools.disableDebugs();
 

Note that you can also easily disable the use of the colors for the logs. Indeed, some standard outputs don't like this kind of ANSI codes:

 Tools.disableColors();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tools.Color Colors that can be used to print log and debug messages to standard output.

Method Summary

Modifier and Type	Method and Description
static void	debug(java.lang.Object obj) Print a new debug message to the standard output, if the debugs are enabled.
static void	debug(java.lang.Object obj, Tools.Color color) Print a new colored debug message to the standard output, if the debugs are enabled.
static void	debug(java.lang.String message) Print a new debug message to the standard output, if the debugs are enabled.
static void	debug(java.lang.String message, Tools.Color color) Print a new colored debug message to the standard output, if the debugs are enabled.
static int	decodeInt(int bitLength, byte[] incoming, int startingBitLocation) Decode an int value from the input byte array.
static void	disableColors() Disable the use of colors to print log/debug messages.
static void	disableDebugs() Disable printing debug messages to the standard output.
static void	disableLogs() Disable printing log messages to the standard output.
static void	enableColors() Enable the use of colors to print log/debug messages.
static void	enableDebugs() Enable printing debug messages to the standard output.
static void	enableLogs() Enable printing log messages to the standard output.
static java.util.BitSet	extractBitSet(int bitLength, byte[] incoming, int startingBitLocation) Extracts a BitSet from the incoming byte array.
static java.lang.String	getBinaryString(byte[] byteArray) Returns the String representation of the byte array given in input.
static void	log(java.lang.Object obj) Print a new log message to the standard output, if the logs are enabled.
static void	log(java.lang.Object obj, Tools.Color color) Print a new colored log message to the standard output, if the logs are enabled.
static void	log(java.lang.String message) Print a new log message to the standard output, if the logs are enabled.
static void	log(java.lang.String message, Tools.Color color) Print a new colored log message to the standard output, if the logs are enabled.
static void	sleepMilliseconds(long millis) Causes the currently executing thread to sleep (temporarily cease execution) for the specified number of milliseconds, subject to the precision and accuracy of system timers and schedulers.

Methods inherited from class java.lang.Object

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

Method Detail

log

public static void log(java.lang.Object obj,
                       Tools.Color color)

Print a new colored log message to the standard output, if the logs are enabled.

Parameters:

obj - the object to print in the log content (obj.toString()).

color - the color used to print the log.

See Also:

enableLogs(), enableColors(), disableLogs(), disableColors()

log

public static void log(java.lang.String message,
                       Tools.Color color)

Print a new colored log message to the standard output, if the logs are enabled.

Parameters:

message - the String message to print in the log content.

color - the color used to print the log.

See Also:

enableLogs(), enableColors(), disableLogs(), disableColors()

log

public static void log(java.lang.Object obj)

Print a new log message to the standard output, if the logs are enabled.

Parameters:

obj - the object to print in the log content (obj.toString()).

See Also:

enableLogs(), disableLogs()

log

public static void log(java.lang.String message)

Print a new log message to the standard output, if the logs are enabled.

Parameters:

message - the String message to print in the log content.

See Also:

enableLogs(), disableLogs()

debug

public static void debug(java.lang.Object obj,
                         Tools.Color color)

Print a new colored debug message to the standard output, if the debugs are enabled.

Parameters:

obj - the object to print in the debug content (obj.toString()).

color - the color used to print the debug.

See Also:

enableDebugs(), enableColors(), disableDebugs(), disableColors()

debug

public static void debug(java.lang.String message,
                         Tools.Color color)

Print a new colored debug message to the standard output, if the debugs are enabled.

Parameters:

message - the String message to print in the debug content.

color - the color used to print the debug.

See Also:

enableDebugs(), enableColors(), disableDebugs(), disableColors()

debug

public static void debug(java.lang.Object obj)

Print a new debug message to the standard output, if the debugs are enabled.

Parameters:

obj - the object to print in the debug content (obj.toString()).

See Also:

enableDebugs(), disableDebugs()

debug

public static void debug(java.lang.String message)

Print a new debug message to the standard output, if the debugs are enabled.

Parameters:

message - the String message to print in the debug content.

See Also:

enableDebugs(), disableDebugs()

enableLogs

public static void enableLogs()

Enable printing log messages to the standard output.

disableLogs

public static void disableLogs()

Disable printing log messages to the standard output.

enableDebugs

public static void enableDebugs()

Enable printing debug messages to the standard output.

disableDebugs

public static void disableDebugs()

Disable printing debug messages to the standard output.

enableColors

public static void enableColors()

Enable the use of colors to print log/debug messages.

disableColors

public static void disableColors()

Disable the use of colors to print log/debug messages.

getBinaryString

public static java.lang.String getBinaryString(byte[] byteArray)

Returns the String representation of the byte array given in input.

Parameters:

byteArray - the byteArray to analyze.

Returns:

the String representation of the byte array given in input.

decodeInt

public static int decodeInt(int bitLength,
                            byte[] incoming,
                            int startingBitLocation)

Decode an int value from the input byte array.

Parameters:

bitLength - the number of bits to decode.

incoming - the byte array to decode from.

startingBitLocation - the starting bit location in the byte array.

Returns:

the decoded value.

extractBitSet

public static java.util.BitSet extractBitSet(int bitLength,
                                             byte[] incoming,
                                             int startingBitLocation)

Extracts a BitSet from the incoming byte array.

If bitLength == -1, extracts from startingBitLocation to the end of the BitSet.

Parameters:

bitLength - the number of bits to extract.

incoming - the byte array from where the BitSet is extracted.

startingBitLocation - the starting location from which the BitSet is extracted.

Returns:

the extracted BitSet.

sleepMilliseconds

public static void sleepMilliseconds(long millis)

Causes the currently executing thread to sleep (temporarily cease execution) for the specified number of milliseconds, subject to the precision and accuracy of system timers and schedulers. The thread does not lose ownership of any monitors.

Allows to properly catch the InterruptedException.

Parameters:

millis - the number of milliseconds to wait.