ArrayConv is a utility used to help slice out arrays out of arrays without cloning them in memory. It was extended upon org.apache.commons.lang3.ArrayUtils.
See: https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/ArrayUtils.html
{% hint style='info' %} ArrayConv History
Initially ArrayConv had a lot more functions until Apache's latest updates which included the functions we required, but is still kept in case of future uses.
{% endhint %}
With reference to https://en.wikipedia.org/wiki/Base64, but not used as such. Similarly it is used to convert values sets (like UUID) into a format that can be safely transmitted over the internet / is readable.
BaseX acts as our library's foundational constructor for the creation of a unique/custom character set (charset). It is not built for performance on large input streams (20 bytes and above) as input values are collected internally into a BigInteger.
{% hint style='Working' %} Constructor
- BaseX(java.lang.String customCharset)
Methods Summary
- bitToStringLength(), charset(), decode(), encode(), md5hash(), sha1hash(), sha256hash(), stringToBitLength()
{% endhint %}
Base62 is the custom charset created consisting the characters of 'A-Z', 'a-z', '0-9' and omitting characters '+', '='.
{% hint style='Working' %} Base62 Default Charset
- A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
- a b c d e f g h i j k l m n o p q r s t u v w x y z
- 0 1 2 3 4 5 6 7 8 9
{% endhint %}
{% hint style='Working' %} Constructor
- Base62()
- Base62(java.lang.String customCharset)
Methods Summary
- getInstance()
{% endhint %}
Base58 is the custom charset created to be used in cases where objects require characters susceptible to human identification error such as 'O';'0', 'I';'l' (which display very similarly when rendered). Consist of characters "A-Z" omitting 'O', "a-z" omitting 'l' and '1-9' omitting '0'.
The default charset is based off bitcoin base58 charset, as explained on :http://en.wikipedia.org/wiki/Base58
{% hint style='Working' %} Base58 Default Charset
- A B C D E F G H I J K L M N P Q R S T U V W X Y Z
- a b c d e f g h i j k m n o p q r s t u v w x y z
- 1 2 3 4 5 6 7 8 9
{% endhint %}
{% hint style='Working' %} Constructor
- Base58()
- Base58(java.lang.String customCharset)
Methods Summary
- getInstance()
{% endhint %}
ConvertJSON is a JSON simplifier which can be used to convert input maps, arrays, lists and objects into JSON strings and vice versa.
{% hint style='Working' %} Methods Summary
Examples of methods (from input to JSON string):
- fromMap, fromList, fromObject, fromArray
(from JSON string to input structure):
- toMap(), toList(), toObject(), toCustomClass(), toObjectArray(), toStringArray(), toDoubleArray(), toIntArray(), toFloatArray(), toLongArray()
{% endhint %}
Illegal JSON format type. Used to handle all format exceptions in this class.
Can be treated as a RuntimeException, and IllegalArgumentException.
ConvertXML is a XML simplifier which can be used to convert XML strings to a structure.
{% hint style='Working' %} Methods Summary
Examples of methods (from XML string to structure):
- toMap(), toCollapsedMap()
{% endhint %}
Illegal JSON format type. Used to handle all format exceptions in this class.
Can be treated as a RuntimeException, and IllegalArgumentException.
DateConv acts as the library's convenience class to convert between date types. The default date format is DD-MM-YYYY.
Core class for all the common variable / primitive type conversions.
Its pattern is inherited into all the GenericConvert struct classes, allows for easy access to variable converters. This has since been split into 2 additional sub-classes. However as this main class inherits them all anyway, it is highly recommended to simply use this class instead.
This split is was done to simplify code maintenance of this package.
{% hint style='Working' %} Methods Summary
- to(), fetch(), split(), normalize()
{% endhint %}
{% hint style='tip' %} Example Usage
toGenericConvertList conversion of generic object
Performs the following strategies in the following order
-
No conversion (if its a GenericConvertList)
-
To GenericConvertList (if its a List)
-
toList -> GenericConvertList conversion
-
Fallback
public static GenericConvertList toGenericConvertList(java.lang.Object input, java.lang.Object fallbck)
where,
- input = input value to convert
- fallbck = the fallback default
and returning the converted value.
{% endhint %}
Provide several Globally Unique Identifier (GUID) functionalities. Namely paired with other conversion classes, input with the Unique GUID Value (UUID) to return a UUId object and arrays.
{% hint style='tip' %} Example Usage
Paired with Base64
public static java.lang.String base64()
with,
- parameters: UUID - Unique GUID value
returns a random 22 character base64 GUID string.
{% endhint %}
A utility conversion class to help convert List values from one type to another.
{% hint style='Working' %} Methods Summary
- objectListToStringArray(), objectToString(), deduplicateValuesWithoutArrayOrder(), toStringSet()
{% endhint %}
A utility conversion class to help convert Map values from one type to another.
{% hint style='Working' %} Methods Summary
- listToArray(), singleToArray(), fromFullyQualifiedKeys(), toFullyQualifiedKeys()
{% endhint %}
Class to handle the manipulation of nested objects, in a Map/List.
{% hint style='info' %} NestedObject History
Originally a part of the GenericConvert class, but has since been extracted and isolated.
{% endhint %}
{% hint style='tip' %} Example Usage
public static <K,V> void unpackFullyQualifiedNameKeys(java.util.Map<K,V> inMap)
Takes in a map, search its keys for Fully Qualified Name formatting. Unpack the various key / values related to it.
So for example,
{ "a[0].b" : "hello" }
Will unpack to
{
"a" : [
{
"b" : "hello"
}
]
}
This Unpacks all keynames, and rewrites any underlying map/list implementation if needed. Note that while this helps normalize input parameters against a large collection of format interpration, its implications are rarely well understood when things does not work as intended.
{% endhint %}
Utility function to do a common regex search and replace.
{% hint style='tip' %} Example Usage
public static java.lang.String removeAllWhiteSpace(java.lang.String input)
where input string could be "AB CD", and using \s to remove white space,
returns "ABCD" {% endhint %}
A proxy to apache.commons.lang3.StringEscapeUtils.
{% hint style='tip' %} Example Usage
………………………………………………………….javaS
Notable static functions inherited (all with single string input) + escapeCsv + escapeEmacScript + escapeHtml4 + escapeHtml3 + escapeJava + escapeCsv
And its inverse function inherited (all with single string input) + unescapedCsv + unescapedEmacScript + unescapedHtml4 + unescapedHtml3 + unescapedJava + unescapedCsv
{% endhint %}