nl.nn.credentialprovider.util

Class Misc

java.lang.Object

nl.nn.credentialprovider.util.Misc

public class Misc
extends Object

Miscellaneous conversion functions.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFERSIZE
static String	DEFAULT_INPUT_STREAM_ENCODING Deprecated.
static String	LINE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
Misc()

Method Summary

Modifier and Type	Method and Description
static void	addItemsToList(Collection<String> collection, String list, String collectionDescription, boolean lowercase) Adds items on a string, added by comma separator (ex: "1,2,3"), into a list.
static <T> void	addToSortedListNonUnique(List<T> list, T item)
static <T> void	addToSortedListUnique(List<T> list, T item)
static String	asHex(byte[] buf)
static byte[]	compress(byte[] input) Compresses the input string using the Deflater class of Java.
static byte[]	compress(String input) Compresses the input string using the default stream encoding.
static String	concat(String separator, String... parts)
static String	concatStrings(String part1, String separator, String part2) Concatenates two strings, if specified, uses the separator in between two strings.
static int	countRegex(String string, String regex) Counts the number of characters that the specified reges will affect in the specified string.
static String	createNumericUUID()
static String	createRandomUUID()
static String	createRandomUUID(boolean removeDashes) Creates a Universally Unique Identifier, via the java.util.UUID class (36 characters or 32 characters without dashes).
static String	createSimpleUUID() Creates a Universally Unique Identifier, via the java.rmi.server.UID class.
static String	createUUID()
static byte[]	decompress(byte[] input) Decompresses the compressed byte array.
static void	fileToStream(String filename, OutputStream output) Copies the content of the specified file to an output stream.
static String	fileToString(String fileName) Please consider using resourceToString() instead of relying on files.
static String	fileToString(String fileName, String endOfLineString) Please consider using resourceToString() instead of relying on files.
static void	fileToWriter(String filename, Writer writer) Copies the content of the specified file to a writer.
static String	getBuildOutputDirectory()
static long	getCurrentTimeMillis()
static Properties	getEnvironmentVariables()
static String	getHostname()
static String	getProjectBaseDir()
static byte[]	gunzip(byte[] input) Unzips a zipped byte array to a string by create an expandable byte array to hold the decompressed data.
static byte[]	gzip(byte[] input) Creates an expandable byte array to hold the compressed data.
static byte[]	gzip(String input) Zips the input string with the default input stream encoding.
static boolean	isEmpty(String string)
static boolean	isNotEmpty(String string)
static String	listToString(List list) Converts the list to a string.
static long	parseAge(String value, long defaultValue)
static String	readerToString(Reader reader, String endOfLineString) Copies the content of a reader into a string, adds specified string to the end of the line, if specified.
static void	readerToWriter(Reader reader, Writer writer) Copies the content of a reader to the buffer of a writer.
static String	replace(String source, String from, String to) String replacer.
static byte[]	streamToBytes(InputStream inputStream) Writes the content of an input stream to a byte array.
static void	streamToFile(InputStream inputStream, File file) Writes the content of an input stream to a specified file.
static void	streamToStream(InputStream input, OutputStream output)
static void	streamToStream(InputStream input, OutputStream output, byte[] eof) Writes the content of an input stream to an output stream by copying the buffer of input stream to the buffer of the output stream.
static String	streamToString(InputStream stream)
static String	streamToString(InputStream stream, String streamEncoding)
static String	streamToString(InputStream stream, String endOfLineString, String streamEncoding)
static void	stringToFile(String string, String fileName) Writes the string to a file.
static long	toFileSize(String value, long defaultValue) Converts the file size to bytes.
static int	unsignedByteToInt(byte b) Converts an unsigned byte to its integer representation.
static String	urlDecode(String input)

Methods inherited from class java.lang.Object

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

Field Detail

BUFFERSIZE

public static final int BUFFERSIZE

See Also:

Constant Field Values

DEFAULT_INPUT_STREAM_ENCODING

@Deprecated
public static final String DEFAULT_INPUT_STREAM_ENCODING

Deprecated.

See Also:

Constant Field Values

LINE_SEPARATOR

public static final String LINE_SEPARATOR

Constructor Detail

Misc

public Misc()

Method Detail

createSimpleUUID

public static String createSimpleUUID()

Creates a Universally Unique Identifier, via the java.rmi.server.UID class.

createUUID

public static String createUUID()

createRandomUUID

public static String createRandomUUID(boolean removeDashes)

Creates a Universally Unique Identifier, via the java.util.UUID class (36 characters or 32 characters without dashes).

createRandomUUID

public static String createRandomUUID()

asHex

public static String asHex(byte[] buf)

Returns:

the hexadecimal string representation of the byte array.

createNumericUUID

public static String createNumericUUID()

Returns:

a unique UUID string with length 31 (ipaddress with length 4*3, currentTime with length 13, hashcode with length 6)

unsignedByteToInt

public static int unsignedByteToInt(byte b)

Converts an unsigned byte to its integer representation. Examples:

 Misc.unsignedByteToInt(new Btye(12)) returns 12
 Misc.unsignedByteToInt(new Byte(-12)) returns 244
 

Parameters:

b - byte to be converted.

Returns:

integer that is converted from unsigned byte.

getCurrentTimeMillis

public static long getCurrentTimeMillis()

Returns:

the current time in milliseconds.

fileToWriter

public static void fileToWriter(String filename,
                                Writer writer)
                         throws IOException

Copies the content of the specified file to a writer.

Example:

         Writer writer = new StringWriter();
         Misc.fileToWriter(someFileName, writer);
         System.out.println(writer.toString) // prints the content of the writer
                                               // that's copied from the file.
     

Throws:

IOException - exception to be thrown exception to be thrown if an I/O exception occurs

fileToStream

public static void fileToStream(String filename,
                                OutputStream output)
                         throws IOException

Copies the content of the specified file to an output stream.

Example:

         OutputStream os = new ByteArrayOutputStream
         Misc.fileToStream(someFileName, os);
         System.out.println(os.toString) // prints the content of the output stream
                                           // that's copied from the file.
     

Throws:

IOException - exception to be thrown if an I/O exception occurs

streamToStream

public static void streamToStream(InputStream input,
                                  OutputStream output)
                           throws IOException

Throws:

IOException

streamToStream

public static void streamToStream(InputStream input,
                                  OutputStream output,
                                  byte[] eof)
                           throws IOException

Writes the content of an input stream to an output stream by copying the buffer of input stream to the buffer of the output stream. If eof is specified, appends the eof(could represent a new line) to the outputstream Closes the input stream if specified.

Example:

         String test = "test";
         ByteArrayInputStream bais = new ByteArrayInputStream(test.getBytes());
         OutputStream baos = new ByteArrayOutputStream();
         Misc.streamToStream(bais, baos);
         System.out.println(baos.toString()); // prints "test"
     

Throws:

IOException - exception to be thrown if an I/O exception occurs

streamToFile

public static void streamToFile(InputStream inputStream,
                                File file)
                         throws IOException

Writes the content of an input stream to a specified file.

Example:

         String test = "test";
         ByteArrayInputStream bais = new ByteArrayInputStream(test.getBytes());
         Misc.streamToFile(bais, file); // "test" copied inside the file.
     

Throws:

IOException - exception to be thrown if an I/O exception occurs

streamToBytes

public static byte[] streamToBytes(InputStream inputStream)
                            throws IOException

Writes the content of an input stream to a byte array.

Example:

         String test = "test";
         ByteArrayInputStream bais = new ByteArrayInputStream(test.getBytes());
         byte[] arr = Misc.streamToBytes(bais);
         System.out.println(new String(arr, StandardCharsets.UTF_8)); // prints "test"
     

Throws:

IOException

readerToWriter

public static void readerToWriter(Reader reader,
                                  Writer writer)
                           throws IOException

Copies the content of a reader to the buffer of a writer.

Example:

         Reader reader = new StringReader("test");
         Writer writer = new StringWriter();
         Misc.readerToWriter(reader, writer, true);
         System.out.println(writer.toString)); // prints "test"
     

Throws:

IOException

fileToString

public static String fileToString(String fileName)
                           throws IOException

Please consider using resourceToString() instead of relying on files.

Throws:

IOException

fileToString

public static String fileToString(String fileName,
                                  String endOfLineString)
                           throws IOException

Please consider using resourceToString() instead of relying on files.

Throws:

IOException

readerToString

public static String readerToString(Reader reader,
                                    String endOfLineString)
                             throws IOException

Copies the content of a reader into a string, adds specified string to the end of the line, if specified.

Example:

         Reader r = new StringReader(" WeAreFrank' \n";
         String s = Misc.readerToString(r, "!!", true);
         System.out.println(s);
         // prints "<root> WeAreFrank!!</root>"
     

Throws:

IOException

streamToString

public static String streamToString(InputStream stream)
                             throws IOException

Throws:

IOException

streamToString

public static String streamToString(InputStream stream,
                                    String streamEncoding)
                             throws IOException

Throws:

IOException

streamToString

public static String streamToString(InputStream stream,
                                    String endOfLineString,
                                    String streamEncoding)
                             throws IOException

Throws:

IOException

stringToFile

public static void stringToFile(String string,
                                String fileName)
                         throws IOException

Writes the string to a file.

Throws:

IOException

replace

public static String replace(String source,
                             String from,
                             String to)

String replacer.

Example:

         String a = "WeAreFrank";
         String res = Misc.replace(a, "WeAre", "IAm");
         System.out.println(res); // prints "IAmFrank"
     

Parameters:

source - is the original string

from - is the string to be replaced

to - is the string which will used to replace

concatStrings

public static String concatStrings(String part1,
                                   String separator,
                                   String part2)

Concatenates two strings, if specified, uses the separator in between two strings. Does not use any separators if both or one of the strings are empty.

Example:

         String a = "We";
         String b = "Frank";
         String separator = "Are";
         String res = Misc.concatStrings(a, separator, b);
         System.out.println(res); // prints "WeAreFrank"
     

Parameters:

part1 - First string

separator - Specified separator

part2 - Second string

Returns:

the concatenated string

concat

public static String concat(String separator,
                            String... parts)

gzip

public static byte[] gzip(String input)
                   throws IOException

Zips the input string with the default input stream encoding.

Throws:

IOException

See Also:

gzip(byte[])

gzip

public static byte[] gzip(byte[] input)
                   throws IOException

Creates an expandable byte array to hold the compressed data.

Example:

         String s = "test";
         byte[] arr = s.getBytes();
         byte[] zipped = Misc.gzip(arr);
         System.out.println(Misc.gunzipToString(zipped)); // prints "test"
     

Throws:

IOException

gunzip

public static byte[] gunzip(byte[] input)
                     throws DataFormatException,
                            IOException

Unzips a zipped byte array to a string by create an expandable byte array to hold the decompressed data. Creates an expandable byte array to hold the compressed data.

Example:

         String s = "test";
         byte[] arr = s.getBytes();
         byte[] zipped = Misc.gzip(arr);
         System.out.println(Misc.gunzipToString(zipped)); // prints "test"
     

Throws:

DataFormatException

IOException

compress

public static byte[] compress(String input)
                       throws IOException

Compresses the input string using the default stream encoding.

Throws:

IOException

See Also:

compress(byte[])

compress

public static byte[] compress(byte[] input)
                       throws IOException

Compresses the input string using the Deflater class of Java.

Example:

         String s = "#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$#!@#$";
         byte[] compressedSymbols = Misc.compress(s);
         assertTrue(compressedSymbols.length < s1.length()); // will assertTrue as compressed one's length should be less than the normal string. However, this may not be the case for shorter strings.
     

Throws:

IOException

decompress

public static byte[] decompress(byte[] input)
                         throws DataFormatException,
                                IOException

Decompresses the compressed byte array.

Example:

          String s = "test";
         byte[] compressed = Misc.compress(s);
         String decompressed = Misc.decompressToString(compressed);
         System.out.print(decompressed); // prints "test"
     

Throws:

DataFormatException

IOException

getEnvironmentVariables

public static Properties getEnvironmentVariables()
                                          throws IOException

Throws:

IOException

getHostname

public static String getHostname()

toFileSize

public static long toFileSize(String value,
                              long defaultValue)

Converts the file size to bytes.

Misc.toFileSize("14GB", 20); // gives out 15032385536

listToString

public static String listToString(List list)

Converts the list to a string.

      List list = new ArrayList();
      list.add("We Are");
      list.add(" Frank");
      String res = Misc.listToString(list); // res gives out "We Are Frank"
 

addItemsToList

public static void addItemsToList(Collection<String> collection,
                                  String list,
                                  String collectionDescription,
                                  boolean lowercase)

Adds items on a string, added by comma separator (ex: "1,2,3"), into a list.

Parameters:

collectionDescription - description of the list

parseAge

public static long parseAge(String value,
                            long defaultValue)

getBuildOutputDirectory

public static String getBuildOutputDirectory()

getProjectBaseDir

public static String getProjectBaseDir()

countRegex

public static int countRegex(String string,
                             String regex)

Counts the number of characters that the specified reges will affect in the specified string.

     String s = "12ab34";
     String regex = "\\d";
     int regexCount = Misc.countRegex(s, regex); // regexCount gives out 4
 

urlDecode

public static String urlDecode(String input)

addToSortedListUnique

public static <T> void addToSortedListUnique(List<T> list,
                                             T item)

addToSortedListNonUnique

public static <T> void addToSortedListNonUnique(List<T> list,
                                                T item)

isEmpty

public static boolean isEmpty(String string)

isNotEmpty

public static boolean isNotEmpty(String string)