com.fivecolibs.utils

Class FCOCUtils

java.lang.Object

com.fivecolibs.utils.FCOCUtils

public final class FCOCUtils
extends java.lang.Object

Miscellaneous useful methods

Version:

1.17

Author:

agardiol

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.Color	m_MEDIUMGREEN Medium green color #00BE00
static java.awt.Color	m_ORANGEWARNING Orange color for warning message on grey #FF870F

Constructor Summary

Constructors

Constructor and Description
FCOCUtils()

Method Summary

Modifier and Type	Method and Description
static void	addChecksum(byte[] acBuffer, int nBufferLength) Add std checksum to a FiveCo packet buffer.
static int	bcd2Int(byte chBcdValue) Convert a BCD value to the corresponding byte value.
static int	byteArrayBEToInt(java.lang.Byte[] aArray, int nIndex) Return an int value from a Byte[] array.
static int	byteArrayBEToInt(byte[] achArray, int nIndex, int nLength) Return an int value from a byte[] array.
static int	byteArrayBEToInt(java.lang.Byte[] aArray, int nIndex, int nLength) Return an int value from a Byte[] array.
static int	byteArrayBEToUnsignedInt(byte[] achArray, int nIndex, int nLength) Return an int value from a byte[] array.
static int	byteArrayLEToInt(java.lang.Byte[] aArray, int nIndex) Return an int value from a Byte[] array.
static int	byteArrayLEToInt(java.lang.Byte[] aArray, int nIndex, int nLength) Return an int value from a Byte[] array.
static java.lang.String	byteArrayLEToString(byte[] achArray, int nOffset, int nMaxLength) Convert part of a byte array to a String object in little endian order
static long	byteArrayLEToUnsignedInt(java.lang.Byte[] aArray, int nIndex) Return a long value from a Byte[] array.
static long	byteArrayLEToUnsignedInt(byte[] achArray, int nIndex, int nLength) Return a long value from a byte[] array.
static long	byteArrayLEToUnsignedInt(java.lang.Byte[] aArray, int nIndex, int nLength) Return a long value from a Byte[] array.
static java.lang.String	byteArrayToString(byte[] achArray, int nOffset, int nMaxLength) Convert part of a byte array to a String object
static java.lang.String	byteArrayToString(java.lang.Byte[] aArray, int nOffset, int nMaxLength) Convert part of a byte array to a String object
static void	centerFrame(javax.swing.JFrame FrameToCenter) Center a frame on the screen.
static <T> T[]	concatArrays(T[] aFirst, T[] aSecond) Concatenate two arrays into one.
static javax.swing.ImageIcon	createImageIcon(java.lang.String szPath)
static java.util.List<java.awt.image.BufferedImage>	getAppIconImages(java.lang.Class<?> ThisClass)
static int	getChecksum(byte[] acBuffer, int nBufferLength) FiveCo's packet checksum calculation
static java.awt.Rectangle	getDisplayBounds()
static java.awt.Dimension	getDisplaySize()
static byte	int2Bcd(int nBinValue) Convert a byte value to its BCD representation.
static void	intToByteArrayBE(int nValue, java.lang.Byte[] aArray, int nIndex) Fill a Byte[] array with an int value.
static void	intToByteArrayBE(int nValue, java.lang.Byte[] aArray, int nIndex, int nLength) Fill a Byte[] array with an int value.
static void	intToByteArrayLE(int nValue, java.lang.Byte[] aArray, int nIndex) Fill a Byte[] array with an int value.
static void	intToByteArrayLE(int nValue, java.lang.Byte[] aArray, int nIndex, int nLength) Fill a Byte[] array with an int value.
static java.lang.String	padHexString(java.lang.String szValue) A multiple of 2 digits string representation of the Hex String argument.
static void	setContainerEnabled(java.awt.Component Comp, boolean isEnabled) Enable or disable a Container and all its children.
static void	setMouseListenerRecursively(javax.swing.JComponent Comp, java.awt.event.MouseAdapter MouseAdapt)
static void	setToolTipRecursively(javax.swing.JComponent Comp, java.lang.String szText, java.awt.event.MouseAdapter MouseAdapt)
static java.lang.String	toHexString(int nValue) Returns a string representation of the integer argument as an unsigned integer in base 16.
static java.lang.String	toHexString(int nValue, int nLength) A string representation of the integer argument as an unsigned integer in base 16.
static void	unsignedIntToByteArrayLE(long lValue, java.lang.Byte[] aArray, int nIndex) Fill a Byte[] array with an int value.
static void	unsignedIntToByteArrayLE(long lValue, java.lang.Byte[] aArray, int nIndex, int nLength) Fill a Byte[] array with an long value.

Methods inherited from class java.lang.Object

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

Field Detail

m_MEDIUMGREEN

public static final java.awt.Color m_MEDIUMGREEN

Medium green color #00BE00

m_ORANGEWARNING

public static final java.awt.Color m_ORANGEWARNING

Orange color for warning message on grey #FF870F

Constructor Detail

FCOCUtils

public FCOCUtils()

Method Detail

getChecksum

public static final int getChecksum(byte[] acBuffer,
                                    int nBufferLength)

FiveCo's packet checksum calculation

Parameters:

acBuffer - Buffer with FiveCo's packet

nBufferLength - Number of byte before checksum

Returns:

Computed checksum

addChecksum

public static final void addChecksum(byte[] acBuffer,
                                     int nBufferLength)

Add std checksum to a FiveCo packet buffer.

Parameters:

acBuffer - Buffer in which checksum must be added

nBufferLength - Number of bytes before checksum

centerFrame

public static final void centerFrame(javax.swing.JFrame FrameToCenter)

Center a frame on the screen.

Parameters:

FrameToCenter - Frame to center on screen

setContainerEnabled

public static final void setContainerEnabled(java.awt.Component Comp,
                                             boolean isEnabled)

Enable or disable a Container and all its children.

Parameters:

Comp - Container

isEnabled - True to enable the container and it's children, false for the inverse

intToByteArrayLE

public static void intToByteArrayLE(int nValue,
                                    java.lang.Byte[] aArray,
                                    int nIndex)

Fill a Byte[] array with an int value.

Parameters:

nValue - The value to be converted in byte value in array in Little Endian representation.

aArray - The array to fill in.

nIndex - The index in the array for the LSB

intToByteArrayLE

public static void intToByteArrayLE(int nValue,
                                    java.lang.Byte[] aArray,
                                    int nIndex,
                                    int nLength)
                             throws java.lang.IllegalArgumentException

Fill a Byte[] array with an int value.

Parameters:

nValue - The value to be converted in byte value in array in Little Endian representation.

aArray - The array to fill in.

nIndex - The index in the array for the LSB

nLength - Byte count for the conversion (1-4)

Throws:

java.lang.IllegalArgumentException - if nLength not between 1 and 4.

unsignedIntToByteArrayLE

public static void unsignedIntToByteArrayLE(long lValue,
                                            java.lang.Byte[] aArray,
                                            int nIndex)

Fill a Byte[] array with an int value.

Parameters:

lValue - The value to be converted in byte value in array in Little Endian representation.

aArray - The array to fill in.

nIndex - The index in the array for the LSB

unsignedIntToByteArrayLE

public static void unsignedIntToByteArrayLE(long lValue,
                                            java.lang.Byte[] aArray,
                                            int nIndex,
                                            int nLength)
                                     throws java.lang.IllegalArgumentException

Fill a Byte[] array with an long value.

Parameters:

lValue - The value to be converted in byte value in array in Little Endian representation.

aArray - The array to fill in.

nIndex - The index in the array for the LSB

nLength - Byte count for the conversion (1-4)

Throws:

java.lang.IllegalArgumentException - if nLength not between 1 and 7.

intToByteArrayBE

public static void intToByteArrayBE(int nValue,
                                    java.lang.Byte[] aArray,
                                    int nIndex)

Fill a Byte[] array with an int value.

Parameters:

nValue - The value to be converted in byte value in array in Big Endian representation.

aArray - The array to fill in.

nIndex - The index in the array for the MSB

intToByteArrayBE

public static void intToByteArrayBE(int nValue,
                                    java.lang.Byte[] aArray,
                                    int nIndex,
                                    int nLength)
                             throws java.lang.IllegalArgumentException

Fill a Byte[] array with an int value.

Parameters:

nValue - The value to be converted in byte value in array in Big Endian representation.

aArray - The array to fill in.

nIndex - The index in the array for the MSB

nLength - Byte count for the conversion (1-4)

Throws:

java.lang.IllegalArgumentException - if nLength not between 1 and 4.

byteArrayLEToInt

public static final int byteArrayLEToInt(java.lang.Byte[] aArray,
                                         int nIndex)

Return an int value from a Byte[] array.

Parameters:

aArray - The array with data.

nIndex - The index in the array for the MSB

Returns:

The value converted from byte array in Little Endian representation.

byteArrayLEToInt

public static final int byteArrayLEToInt(java.lang.Byte[] aArray,
                                         int nIndex,
                                         int nLength)
                                  throws java.lang.IllegalArgumentException

Return an int value from a Byte[] array.

Parameters:

aArray - The array with data.

nIndex - The index in the array for the MSB

nLength - Byte count for the conversion (1-4)

Returns:

The value converted from byte array in Little Endian representation.

Throws:

java.lang.IllegalArgumentException - if nLength not between 1 and 4.

byteArrayLEToUnsignedInt

public static final long byteArrayLEToUnsignedInt(java.lang.Byte[] aArray,
                                                  int nIndex)

Return a long value from a Byte[] array.

Parameters:

aArray - The array with data.

nIndex - The index in the array for the MSB

Returns:

The value converted from byte array in Little Endian representation.

byteArrayLEToUnsignedInt

public static final long byteArrayLEToUnsignedInt(java.lang.Byte[] aArray,
                                                  int nIndex,
                                                  int nLength)
                                           throws java.lang.IllegalArgumentException

Return a long value from a Byte[] array.

Parameters:

aArray - The array with data.

nIndex - The index in the array for the MSB

nLength - Byte count for the conversion (1-4)

Returns:

The value converted from byte array in Little Endian representation.

Throws:

java.lang.IllegalArgumentException - if nLength not between 1 and 7.

byteArrayLEToUnsignedInt

public static final long byteArrayLEToUnsignedInt(byte[] achArray,
                                                  int nIndex,
                                                  int nLength)
                                           throws java.lang.IllegalArgumentException

Return a long value from a byte[] array.

Parameters:

achArray - The array with data.

nIndex - The index in the array for the MSB

nLength - Byte count for the conversion (1-4)

Returns:

The value converted from byte array in Little Endian representation.

Throws:

java.lang.IllegalArgumentException - if nLength not between 1 and 7.

byteArrayBEToInt

public static final int byteArrayBEToInt(java.lang.Byte[] aArray,
                                         int nIndex)

Return an int value from a Byte[] array.

Parameters:

aArray - The array to fill in.

nIndex - The index in the array for the MSB

Returns:

The value converted from byte array in Big Endian representation.

byteArrayBEToInt

public static final int byteArrayBEToInt(java.lang.Byte[] aArray,
                                         int nIndex,
                                         int nLength)
                                  throws java.lang.IllegalArgumentException

Return an int value from a Byte[] array.

Parameters:

aArray - The array to fill in.

nIndex - The index in the array for the MSB

nLength - Byte count for the conversion (1-4)

Returns:

The value converted from byte array in Big Endian representation.

Throws:

java.lang.IllegalArgumentException - if nLength not between 1 and 4.

byteArrayBEToInt

public static final int byteArrayBEToInt(byte[] achArray,
                                         int nIndex,
                                         int nLength)
                                  throws java.lang.IllegalArgumentException

Return an int value from a byte[] array.

Parameters:

achArray - The array to fill in.

nIndex - The index in the array for the MSB

nLength - Byte count for the conversion (1-4)

Returns:

The value converted from byte array in Big Endian representation.

Throws:

java.lang.IllegalArgumentException - if nLength not between 1 and 4.

byteArrayBEToUnsignedInt

public static final int byteArrayBEToUnsignedInt(byte[] achArray,
                                                 int nIndex,
                                                 int nLength)
                                          throws java.lang.IllegalArgumentException

Return an int value from a byte[] array.

Parameters:

achArray - The array to fill in.

nIndex - The index in the array for the MSB

nLength - Byte count for the conversion (1-4)

Returns:

The value converted from byte array in Big Endian representation.

Throws:

java.lang.IllegalArgumentException - if nLength not between 1 and 4.

int2Bcd

public static final byte int2Bcd(int nBinValue)
                          throws java.lang.IllegalArgumentException

Convert a byte value to its BCD representation.

Parameters:

nBinValue - The value to convert (0-99).

Returns:

The value converted in BCD (in a byte value).

Throws:

java.lang.IllegalArgumentException - if nLength not between 0 and 99.

bcd2Int

public static final int bcd2Int(byte chBcdValue)

Convert a BCD value to the corresponding byte value.

Parameters:

chBcdValue - The BCD value to convert.

Returns:

The value converted in int value.

toHexString

public static final java.lang.String toHexString(int nValue)

Returns a string representation of the integer argument as an unsigned integer in base 16.

The unsigned integer value is the argument plus 2³² if the argument is negative; otherwise, it is equal to the argument. This value is converted to a string of ASCII digits in hexadecimal (base 16) with leading 0s

Parameters:

nValue - The value to be converted in Hex String

Returns:

A string representation of the integer argument as an unsigned integer in base 16 with a multiple of 2 digits.

toHexString

public static final java.lang.String toHexString(int nValue,
                                                 int nLength)

A string representation of the integer argument as an unsigned integer in base 16.

The unsigned integer value is the argument plus 2³² if the argument is negative; otherwise, it is equal to the argument. This value is converted to a string of ASCII digits in hexadecimal (base 16) with leading 0s

Parameters:

nValue - The value to be converted in Hex String

nLength - Minimum of digits for 0s padding

Returns:

A string representation of the integer argument as an unsigned integer in base 16 with a multiple of nLength of digits.

padHexString

public static final java.lang.String padHexString(java.lang.String szValue)

A multiple of 2 digits string representation of the Hex String argument.

In other word, this method add simply 0's padding.

Parameters:

szValue - The hex string value to be converted in multiple of 2 digits Hex String

Returns:

A multiple of 2 digits string representation of the argument

byteArrayToString

public static final java.lang.String byteArrayToString(byte[] achArray,
                                                       int nOffset,
                                                       int nMaxLength)

Convert part of a byte array to a String object

Parameters:

achArray - The byte array with data.

nOffset - Offset of string in byte array.

nMaxLength - Max char count in byte array.

Returns:

A String object filled with chars in byte array.

byteArrayToString

public static final java.lang.String byteArrayToString(java.lang.Byte[] aArray,
                                                       int nOffset,
                                                       int nMaxLength)

Convert part of a byte array to a String object

Parameters:

aArray - The Byte array with data.

nOffset - Offset of string in byte array.

nMaxLength - Max char count in byte array.

Returns:

A String object filled with chars in byte array.

byteArrayLEToString

public static final java.lang.String byteArrayLEToString(byte[] achArray,
                                                         int nOffset,
                                                         int nMaxLength)

Convert part of a byte array to a String object in little endian order

Parameters:

achArray - The byte array with data.

nOffset - Offset of string in byte array.

nMaxLength - Max char count in byte array.

Returns:

A String object filled with chars in byte array.

concatArrays

public static final <T> T[] concatArrays(T[] aFirst,
                                         T[] aSecond)

Concatenate two arrays into one.

Type Parameters:

T - Return array type

Parameters:

aFirst - First array

aSecond - Second array

Returns:

A <T> type array

createImageIcon

public static javax.swing.ImageIcon createImageIcon(java.lang.String szPath)

Parameters:

szPath - Path to icon

Returns:

An ImageIcon object

getAppIconImages

public static java.util.List<java.awt.image.BufferedImage> getAppIconImages(java.lang.Class<?> ThisClass)
                                                                     throws java.io.IOException

Parameters:

ThisClass - App class to find icon location

Returns:

An ArrayList<Image> containing icons found

Throws:

java.io.IOException - If file not found or not readable

setMouseListenerRecursively

public static void setMouseListenerRecursively(javax.swing.JComponent Comp,
                                               java.awt.event.MouseAdapter MouseAdapt)

Parameters:

Comp - Main JComponent to set mouse listener

MouseAdapt - An mouse adapter to catch mousePressed and mouseReleased events

setToolTipRecursively

public static void setToolTipRecursively(javax.swing.JComponent Comp,
                                         java.lang.String szText,
                                         java.awt.event.MouseAdapter MouseAdapt)

Parameters:

Comp - Main JComponent to set tooltip text

szText - Text of tooltip

MouseAdapt - An optional mouse adapter to catch mousePressed and mouseReleased events

getDisplaySize

public static java.awt.Dimension getDisplaySize()

Returns:

Display size in pixels. On multiple display environment, it is assumed that screen are horizontally positioned.

getDisplayBounds

public static java.awt.Rectangle getDisplayBounds()

Returns:

Display bounds in pixels. On multiple display environment, it is assumed that screen are horizontally positioned.