Module jpms_dss_utils

Package eu.europa.esig.dss.utils

Interface IUtils

public interface IUtils

The interface contains the common methods to be used within the DSS core

Method Summary

Modifier and Type	Method	Description
boolean	areStringsEqual(String text1, String text2)	Checks if the strings are equal Ex.
boolean	areStringsEqualIgnoreCase(String text1, String text2)	Checks if the strings are equal with case ignore Ex.
int	arraySize(byte[] array)	Gets size of the byte array.
int	arraySize(char[] array)	Gets size of the byte array.
int	arraySize(Object[] array)	Gets size of the array.
void	cleanDirectory(File directory)	Cleans the directory
void	closeQuietly(Closeable closeable)	Closes quietly
int	collectionSize(Collection collection)	Gets the size of the collection
boolean	compareInputStreams(InputStream stream1, InputStream stream2)	Compares content of two InputStreams
byte[]	concat(byte[]... byteArrays)	Concatenates byte arrays to a single byte array
<T> boolean	containsAny(Collection<T> superCollection, Collection<T> subCollection)	This method returns boolean result whether the superCollection contains any element of the subCollection Ex.
void	copy(InputStream is, OutputStream os)	Copies is to os
boolean	endsWithIgnoreCase(String text, String expected)	Checks if the string ends with case ignore Ex.
byte[]	fromBase64(String base64)	Transforms a base64-encoded string to byte array
byte[]	fromHex(String hex)	Transforms a HEX-encoded string to byte array
String	getFileNameExtension(String filename)	This method returns an extension for the given filename Ex.
long	getInputStreamSize(InputStream is)	Gets the size of the InputStream content
boolean	isArrayEmpty(byte[] array)	Checks if the byte array is null or empty
boolean	isArrayEmpty(char[] array)	Checks if the char array is null or empty
boolean	isArrayEmpty(Object[] array)	Checks if the array is null or empty
boolean	isArrayNotEmpty(byte[] array)	Checks if the byte array is not null nor empty
boolean	isArrayNotEmpty(char[] array)	Checks if the char array is not null nor empty
boolean	isArrayNotEmpty(Object[] array)	Checks if the array is not null nor empty
boolean	isBase64Encoded(String base64String)	Checks if the string is base64-encoded
boolean	isCollectionEmpty(Collection collection)	Checks if the collection is null or empty
boolean	isCollectionNotEmpty(Collection collection)	Checks if the collection is not null nor empty
boolean	isHexEncoded(String hexString)	Checks if the string is HEX (base16) encoded
boolean	isMapEmpty(Map<?,?> map)	Checks if the map is null or empty
boolean	isMapNotEmpty(Map<?,?> map)	Checks if the map is not null nor empty
boolean	isStringBlank(String text)	Checks if the string is blank Ex.
boolean	isStringDigits(String text)	Checks if the string contains only digits Ex. "123" = true; "1a2b" = false
boolean	isStringEmpty(String text)	Checks if the string is empty Ex.
boolean	isStringNotBlank(String text)	Checks if the string is not blank Ex.
boolean	isStringNotEmpty(String text)	Checks if the string is not empty Ex.
boolean	isTrue(Boolean bool)	Checks if the Boolean value is set to true NOTE: if null, returns false!
String	joinStrings(Collection<String> strings, String separator)	Joins the strings with the given separator Ex.
Collection<File>	listFiles(File folder, String[] extensions, boolean recursive)	Lists all files from the folder with the given extensions
String	lowerCase(String text)	Converts a string to its lower case representation Ex.
<T> List<T>	reverseList(List<T> list)	Creates a reversed copy of the list
boolean	startsWith(byte[] byteArray, byte[] prefixArray)	Checks if the byteArray starts with prefixArray
boolean	startsWith(InputStream inputStream, byte[] prefixArray)	Checks if the inputStream starts with prefixArray.
byte[]	subarray(byte[] array, int start, int length)	Returns a subArray, starting from position start with the defined length length
String	substringAfter(String text, String after)	Returns a substring after the specified character Ex.
String	toBase64(byte[] bytes)	Transforms the binaries to String base64-encoded representation
byte[]	toByteArray(InputStream is)	Reads the InputStream and returns the resulting byte array
String	toHex(byte[] bytes)	Transforms the binaries to String HEX representation
String	trim(String text)	Trims the string, by removing all leading and descending spaces and lines Ex. " 123 " = "123"
String	upperCase(String text)	Converts a string to its upper case representation Ex.
void	write(byte[] content, OutputStream os)	Writes content to os

Method Details

isStringEmpty

boolean isStringEmpty(String text)

Checks if the string is empty Ex. "nowina" = false; "" = true NOTE: blank string (e.g. " ") is not empty!

Parameters:

text - String

Returns:

TRUE if the string is empty, FALSE otherwise

isStringNotEmpty

boolean isStringNotEmpty(String text)

Checks if the string is not empty Ex. "nowina" = true; "" = false NOTE: blank string (e.g. " ") is not empty!

Parameters:

text - String

Returns:

TRUE if the string is not empty, FALSE otherwise

isStringBlank

boolean isStringBlank(String text)

Checks if the string is blank Ex. "nowina" = false; " " = true

Parameters:

text - String

Returns:

TRUE if the string is blank, FALSE otherwise

isStringNotBlank

boolean isStringNotBlank(String text)

Checks if the string is not blank Ex. "nowina" = true; " " = false

Parameters:

text - String

Returns:

TRUE if the string is not blank, FALSE otherwise

areStringsEqual

boolean areStringsEqual(String text1,
 String text2)

Checks if the strings are equal Ex. "nowina" == "nowina" = true; "nowina" == "Nowina" = false

Parameters:

text1 - String

text2 - String

Returns:

TRUE if the strings are equal, FALSE otherwise

areStringsEqualIgnoreCase

boolean areStringsEqualIgnoreCase(String text1,
 String text2)

Checks if the strings are equal with case ignore Ex. "nowina" == "Nowina" = true; "water" == "fire" = false

Parameters:

text1 - String

text2 - String

Returns:

TRUE if the strings are equal with case ignore, FALSE otherwise

isStringDigits

boolean isStringDigits(String text)

Checks if the string contains only digits Ex. "123" = true; "1a2b" = false

Parameters:

text - String

Returns:

TRUE if the string contains only digits, FALSE otherwise

trim

String trim(String text)

Trims the string, by removing all leading and descending spaces and lines Ex. " 123 " = "123"

Parameters:

text - String

Returns:

the trimmed string

joinStrings

String joinStrings(Collection<String> strings,
 String separator)

Joins the strings with the given separator Ex. "Nowina" "123", "," = "Nowina,123"

Parameters:

strings - a collection of Strings

separator - String

Returns:

the joined string

concat

byte[] concat(byte[]... byteArrays)

Concatenates byte arrays to a single byte array

Parameters:

byteArrays - an array of byte arrays to be concatenated

Returns:

byte array

substringAfter

String substringAfter(String text,
 String after)

Returns a substring after the specified character Ex. "aaaaa?bbb", "?" = "bbb"

Parameters:

text - String to get a substring from

after - String string to get a substring after which

Returns:

the substring

endsWithIgnoreCase

boolean endsWithIgnoreCase(String text,
 String expected)

Checks if the string ends with case ignore Ex. "hello", "LO" = true; "hello", "a" = false

Parameters:

text - String to check

expected - String the end string to check

Returns:

TRUE if the string ends with case ignore, FALSE otherwise

getFileNameExtension

String getFileNameExtension(String filename)

This method returns an extension for the given filename Ex. "file.xml" = "xml"; "document.pdf" = "pdf"

Parameters:

filename - String representing a filename extracted from a file

Returns:

String extension

lowerCase

String lowerCase(String text)

Converts a string to its lower case representation Ex. "Nowina" = "nowina"

Parameters:

text - String

Returns:

the lower case string

upperCase

String upperCase(String text)

Converts a string to its upper case representation Ex. "Nowina" = "NOWINA"

Parameters:

text - String

Returns:

the upper case string

isArrayEmpty

boolean isArrayEmpty(Object[] array)

Checks if the array is null or empty

Parameters:

array - to check

Returns:

TRUE if the array is null or empty, FALSE otherwise

isArrayNotEmpty

boolean isArrayNotEmpty(Object[] array)

Checks if the array is not null nor empty

Parameters:

array - to check

Returns:

TRUE if the array is not null nor empty, FALSE otherwise

arraySize

int arraySize(Object[] array)

Gets size of the array. If null, returns 0.

Parameters:

array - to check

Returns:

size of the given array

isArrayEmpty

boolean isArrayEmpty(byte[] array)

Checks if the byte array is null or empty

Parameters:

array - byte array to check

Returns:

TRUE if the byte array is null or empty, FALSE otherwise

isArrayNotEmpty

boolean isArrayNotEmpty(byte[] array)

Checks if the byte array is not null nor empty

Parameters:

array - byte array to check

Returns:

TRUE if the byte array is not null nor empty, FALSE otherwise

arraySize

int arraySize(byte[] array)

Gets size of the byte array. If null, returns 0.

Parameters:

array - byte array to check

Returns:

size of the given array

isArrayEmpty

boolean isArrayEmpty(char[] array)

Checks if the char array is null or empty

Parameters:

array - char array to check

Returns:

TRUE if the char array is null or empty, FALSE otherwise

isArrayNotEmpty

boolean isArrayNotEmpty(char[] array)

Checks if the char array is not null nor empty

Parameters:

array - char array to check

Returns:

TRUE if the char array is not null nor empty, FALSE otherwise

arraySize

int arraySize(char[] array)

Gets size of the byte array. If null, returns 0.

Parameters:

array - byte array to check

Returns:

size of the given array

subarray

byte[] subarray(byte[] array,
 int start,
 int length)

Returns a subArray, starting from position start with the defined length length

Parameters:

array - byte array to get subArray from

start - the start index of the subArray

length - the final index of the subArray to be copied

Returns:

subArray

isTrue

boolean isTrue(Boolean bool)

Checks if the Boolean value is set to true NOTE: if null, returns false!

Parameters:

bool - Boolean

Returns:

TRUE if the value is set to true, FALSE otherwise

isCollectionEmpty

boolean isCollectionEmpty(Collection collection)

Checks if the collection is null or empty

Parameters:

collection - to check

Returns:

TRUE if the collection is null or empty, FALSE otherwise

isCollectionNotEmpty

boolean isCollectionNotEmpty(Collection collection)

Checks if the collection is not null nor empty

Parameters:

collection - to check

Returns:

TRUE if the collection is not null nor empty, FALSE otherwise

isMapEmpty

boolean isMapEmpty(Map<?,?> map)

Checks if the map is null or empty

Parameters:

map - to check

Returns:

TRUE if the map is null or empty, FALSE otherwise

isMapNotEmpty

boolean isMapNotEmpty(Map<?,?> map)

Checks if the map is not null nor empty

Parameters:

map - to check

Returns:

TRUE if the map is not null nor empty, FALSE otherwise

collectionSize

int collectionSize(Collection collection)

Gets the size of the collection

Parameters:

collection - Collection

Returns:

size of the collection

isHexEncoded

boolean isHexEncoded(String hexString)

Checks if the string is HEX (base16) encoded

Parameters:

hexString - String

Returns:

TRUE if he string is HEX encoded, FALSE otherwise

toHex

String toHex(byte[] bytes)

Transforms the binaries to String HEX representation

Parameters:

bytes - byte array

Returns:

String HEX-encoded

fromHex

byte[] fromHex(String hex)

Transforms a HEX-encoded string to byte array

Parameters:

hex - String hex-encoded

Returns:

byte array

isBase64Encoded

boolean isBase64Encoded(String base64String)

Checks if the string is base64-encoded

Parameters:

base64String - String

Returns:

TRUE if the String is base64-encoded, FALSE otherwise

toBase64

String toBase64(byte[] bytes)

Transforms the binaries to String base64-encoded representation

Parameters:

bytes - byte array

Returns:

String base64-encoded

fromBase64

byte[] fromBase64(String base64)

Transforms a base64-encoded string to byte array

Parameters:

base64 - String base64-encoded

Returns:

byte array

toByteArray

byte[] toByteArray(InputStream is)
            throws IOException

Reads the InputStream and returns the resulting byte array

Parameters:

is - InputStream

Returns:

byte array

Throws:

IOException - if an exception occurs

closeQuietly

void closeQuietly(Closeable closeable)

Closes quietly

Parameters:

closeable - Closeable

copy

void copy(InputStream is,
 OutputStream os)
   throws IOException

Copies is to os

Parameters:

is - InputStream to copy

os - OutputStream to write the value into

Throws:

IOException - if an exception occurs

write

void write(byte[] content,
 OutputStream os)
    throws IOException

Writes content to os

Parameters:

content - byte array to write

os - OutputStream to write the value into

Throws:

IOException - if an exception occurs

getInputStreamSize

long getInputStreamSize(InputStream is)
                 throws IOException

Gets the size of the InputStream content

Parameters:

is - InputStream

Returns:

size

Throws:

IOException - if an exception occurs

compareInputStreams

boolean compareInputStreams(InputStream stream1,
 InputStream stream2)
                     throws IOException

Compares content of two InputStreams

Parameters:

stream1 - InputStream

stream2 - InputStream

Returns:

TRUE if the content of two InputStream is equal, FALSE otherwise

Throws:

IOException - if an exception on InputStream read occurs

startsWith

boolean startsWith(byte[] byteArray,
 byte[] prefixArray)

Checks if the byteArray starts with prefixArray

Parameters:

byteArray - byte array to verify

prefixArray - byte array used on verification

Returns:

TRUE if the byte array starts with a prefix array, FALSE otherwise

startsWith

boolean startsWith(InputStream inputStream,
 byte[] prefixArray)
            throws IOException

Checks if the inputStream starts with prefixArray.

Parameters:

inputStream - byte array to verify

prefixArray - byte array used on verification

Returns:

TRUE if the InputStream starts with a prefix array, FALSE otherwise

Throws:

IOException - if an exception occurs

cleanDirectory

void cleanDirectory(File directory)
             throws IOException

Cleans the directory

Parameters:

directory - File

Throws:

IOException - if an exception occurs

listFiles

Collection<File> listFiles(File folder,
 String[] extensions,
 boolean recursive)

Lists all files from the folder with the given extensions

Parameters:

folder - File the directory to get files from

extensions - Strings to get files with

recursive - defines if the files has to be obtained recursively (from children directories)

Returns:

a collection of Files

reverseList

<T> List<T> reverseList(List<T> list)

Creates a reversed copy of the list

Type Parameters:

T - the class of list elements

Parameters:

list - List to get a reversed copy of

Returns:

reversed list

containsAny

<T> boolean containsAny(Collection<T> superCollection,
 Collection<T> subCollection)

This method returns boolean result whether the superCollection contains any element of the subCollection Ex. {'A', 'B', 'C'}, {'B', 'C', 'D'} = TRUE

Type Parameters:

T - object

Parameters:

superCollection - first collection

subCollection - second collection

Returns:

TRUE if both collection intersect each other, FALSE otherwise