Utility (Cable Database 5.4.1 API)

java.lang.Object
- org.openepics.cable.util.Utility

```
public class Utility
extends Object
```
Contains some utility methods.

Author:

Sunil Sah, Lars Johansson

Field Summary

Fields
Modifier and Type Field and Description

static String MESSAGE_SUMMARY_ERROR

static String MESSAGE_SUMMARY_SUCCESS

static String XLSX_CONTENT_TYPE

Fields
Modifier and Type	Field and Description
`static String`	`MESSAGE_SUMMARY_ERROR`
`static String`	`MESSAGE_SUMMARY_SUCCESS`
`static String`	`XLSX_CONTENT_TYPE`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`equalsFloat(Float... f)` Compares objects and returns true if objects are not null and values of objects are equal.
`static String`	`formatOverlayContentText(String string)` Breaks string if it is too long.
`static String`	`formatRecordValue(String string)` (Default) Formats string from record value.
`static String`	`formatRecordValueTrimFrom(String string)` (Default) Formats string from record value, trimming all leading and trailing whitespaces.
`static String`	`formatWhitespace(String string)` Formats given string by collapsing and trimming all whitespaces.
`static String`	`formatWhitespaceTrimFrom(String string)` Formats given string by collapsing and trimming all leading and trailing whitespaces.
`static void`	`isFloatEntered(Object value)` Utility method used for Double validation.
`static void`	`isIntegerEntered(Object value)` Utility method for Integer validation.
`static boolean`	`isNullOrEmpty(Collection<?> collection)` Checks whether a `Collection` is `null` or empty.
`static boolean`	`isNullOrEmpty(Map<?,?> map)` Checks whether a `Map` is `null` or empty.
`static void`	`isURLEntered(Object value)` Utility method used for URL validation.
`static void`	`isValidCableClass(Object value)` Utility method used for cable class validation.
`static void`	`isValidLbsTag(Object value)` Utility method used for Lbs tag validation.
`static void`	`isValidSubsystem(Object value)` Utility method used for subsystem validation.
`static void`	`isValidSystem(Object value)` Utility method used for system validation.
`static String`	`nullIfEmpty(String string)` Returns `null` if string is empty, otherwise string.
`static List<String>`	`splitStringIntoList(String data)` Splits a string at "," and returns results as a list
`static Date`	`toDate(Object value)` Converts value to Date or null if value is null or empty.
`static Date`	`toDateNull(Object value)` Converts value to Date or null if value is null or empty or cannot be converted.
`static Float`	`toFloat(String value)` Converts value to Float or null if value is null or empty.
`static Integer`	`toInteger(String value)` Converts value to Integer or null if value is null or empty.
`static String`	`upperCase(String string)` Returns upper case if string is not `null`, otherwise `null`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MESSAGE_SUMMARY_SUCCESS
```
public static final String MESSAGE_SUMMARY_SUCCESS
```
    See Also:
    
    Constant Field Values
  - MESSAGE_SUMMARY_ERROR
```
public static final String MESSAGE_SUMMARY_ERROR
```
    See Also:
    
    Constant Field Values
  - XLSX_CONTENT_TYPE
```
public static final String XLSX_CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - isValidSystem
```
public static void isValidSystem(Object value)
```
    Utility method used for system validation.
    
    Parameters:
    
    value - value
    
    Throws:
    
    javax.faces.validator.ValidatorException - if value is not valid system
  - isValidSubsystem
```
public static void isValidSubsystem(Object value)
```
    Utility method used for subsystem validation.
    
    Parameters:
    
    value - value
    
    Throws:
    
    javax.faces.validator.ValidatorException - if value is not valid subsystem
  - isValidCableClass
```
public static void isValidCableClass(Object value)
```
    Utility method used for cable class validation.
    
    Parameters:
    
    value - value
    
    Throws:
    
    javax.faces.validator.ValidatorException - if value is not valid cable class
  - isValidLbsTag
```
public static void isValidLbsTag(Object value)
```
    Utility method used for Lbs tag validation.
    
    Parameters:
    
    value - value
    
    Throws:
    
    javax.faces.validator.ValidatorException - if value is not valid Lbs tag
  - isURLEntered
```
public static void isURLEntered(Object value)
```
    Utility method used for URL validation.
    
    Parameters:
    
    value - value
    
    Throws:
    
    javax.faces.validator.ValidatorException - if value is not valid URL
  - isIntegerEntered
```
public static void isIntegerEntered(Object value)
```
    Utility method for Integer validation.
    
    Parameters:
    
    value - value
    
    Throws:
    
    javax.faces.validator.ValidatorException - if value is not valid Integer
  - isFloatEntered
```
public static void isFloatEntered(Object value)
```
    Utility method used for Double validation.
    
    Parameters:
    
    value - value
    
    Throws:
    
    javax.faces.validator.ValidatorException - if value is not valid Double
  - isNullOrEmpty
```
public static boolean isNullOrEmpty(Collection<?> collection)
```
    Checks whether a Collection is null or empty.
    
    Parameters:
    
    collection - the collection to test
    
    Returns:
    
    true if collection is null or empty, false otherwise
  - isNullOrEmpty
```
public static boolean isNullOrEmpty(Map<?,?> map)
```
    Checks whether a Map is null or empty.
    
    Parameters:
    
    map - the map to test
    
    Returns:
    
    true if map is null or empty, false otherwise
  - nullIfEmpty
```
public static String nullIfEmpty(String string)
```
    Returns null if string is empty, otherwise string.
    
    Parameters:
    
    string - string
    
    Returns:
    
    null if string is empty, otherwise string
  - formatWhitespace
```
public static String formatWhitespace(String string)
```
    Formats given string by collapsing and trimming all whitespaces.
    
    Parameters:
    
    string - to format
    
    Returns:
    
    formatted string or null if string to format is null
  - formatWhitespaceTrimFrom
```
public static String formatWhitespaceTrimFrom(String string)
```
    Formats given string by collapsing and trimming all leading and trailing whitespaces. Does not format whitespaces inside string.
    
    Parameters:
    
    string - to format
    
    Returns:
    
    formatted string or null if string to format is null
  - formatRecordValue
```
public static String formatRecordValue(String string)
```
    (Default) Formats string from record value.
    
    Parameters:
    
    string - string
    
    Returns:
    
    formats string from record value
  - formatRecordValueTrimFrom
```
public static String formatRecordValueTrimFrom(String string)
```
    (Default) Formats string from record value, trimming all leading and trailing whitespaces.
    
    Parameters:
    
    string - string
    
    Returns:
    
    formats string from record value
  - formatOverlayContentText
```
public static String formatOverlayContentText(String string)
```
    Breaks string if it is too long.
    
    Parameters:
    
    string - string to format.
    
    Returns:
    
    new reformatted string.
  - splitStringIntoList
```
public static List<String> splitStringIntoList(String data)
```
    Splits a string at "," and returns results as a list
    
    Parameters:
    
    data - string of data to split
    
    Returns:
    
    a list of separated values or null if data to split is null
  - equalsFloat
```
public static boolean equalsFloat(Float... f)
```
    Compares objects and returns true if objects are not null and values of objects are equal.
    Note
    - exceptions as explained in Float.equals(Object)
    - at least two objects needed for comparison
    Parameters:
    
    f - variable number of float parameters to compare
    
    Returns:
    
    true if objects are not null and values of objects are equal, false otherwise
    
    See Also:
    
    Float.equals(Object)
  - toInteger
```
public static Integer toInteger(String value)
```
    Converts value to Integer or null if value is null or empty.
    
    Parameters:
    
    value - the value to be converted to double
    
    Returns:
    
    the double value if the value object can be converted to double or null otherwise
    
    Throws:
    
    NumberFormatException - if the value cannot be converted.
  - toFloat
```
public static Float toFloat(String value)
```
    Converts value to Float or null if value is null or empty.
    
    Parameters:
    
    value - the value to be converted to double
    
    Returns:
    
    the double value if the value object can be converted to double or null otherwise
    
    Throws:
    
    NumberFormatException - if the value cannot be converted.
  - toDate
```
public static Date toDate(Object value)
```
    Converts value to Date or null if value is null or empty.
    
    Parameters:
    
    value - the value to be casted to date
    
    Returns:
    
    the date if the value object is of type Date
    
    Throws:
    
    ClassCastException - if the value cannot be converted.
  - toDateNull
```
public static Date toDateNull(Object value)
```
    Converts value to Date or null if value is null or empty or cannot be converted.
    
    Parameters:
    
    value - the value to be casted to date
    
    Returns:
    
    the date if the value object is of type Date
  - upperCase
```
public static String upperCase(String string)
```
    Returns upper case if string is not null, otherwise null.
    
    Parameters:
    
    string - string
    
    Returns:
    
    upper case if string is not null, otherwise null

Class Utility

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MESSAGE_SUMMARY_SUCCESS

MESSAGE_SUMMARY_ERROR

XLSX_CONTENT_TYPE

Method Detail

isValidSystem

isValidSubsystem

isValidCableClass

isValidLbsTag

isURLEntered

isIntegerEntered

isFloatEntered

isNullOrEmpty

isNullOrEmpty

nullIfEmpty

formatWhitespace

formatWhitespaceTrimFrom

formatRecordValue

formatRecordValueTrimFrom

formatOverlayContentText

splitStringIntoList

equalsFloat

toInteger

toFloat

toDate

toDateNull

upperCase