MarshalUtils (stumps 1.0-SNAPSHOT API)

java.lang.Object
- com.neurosys.utils.MarshalUtils

```
public class MarshalUtils
extends Object
```
For marshalling of strings, collections etc.

Author:

Arjun Dhar

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MarshalUtils.GenericTransformer<V,T>` Deprecated.
`static class`	`MarshalUtils.Replacer` use this to pass to regexReplace for implementing custom RegEx replacements. It will allow the regexReplace to dynamically substitute the pattern matching RegEx with substitute(String) of this class.
`static class`	`MarshalUtils.Transformer<T>` Deprecated.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLEAN_ALL_EXCEPT_ALPHANUMERIC`
`static String`	`CLEAN_ALL_WITHSPACE_EXCEPT_ALPHANUMERIC`
`static org.apache.commons.collections.Transformer`	`hierarchyTransformer` Convert the `List` of `HierarchialDomainObject` to a Comma separated Query consumable String of hierarchies Usage :`StringUtils.join(CollectionUtils.transformedCollection(List<HierarchialDomainObject>, this), ',')`
`static MarshalUtils.GenericTransformer`	`jsonAuthTransformer`
`static MarshalUtils.GenericTransformer<net.sf.ezmorph.bean.MorphDynaBean,Authorization>`	`morphDynaBeanToAuthTransformer`
`static String`	`NAME_PATTERN`
`static MarshalUtils.Transformer`	`normalizer`
`static org.apache.commons.collections.Transformer`	`parentIdTransformer` Convert the `List` of `HierarchialDomainObject` to a Comma separated Query consumable String of parent Ids Usage :`StringUtils.join(CollectionUtils.transformedCollection(List<HierarchialDomainObject>, this), ',')`

Constructor Summary

Constructors
Constructor and Description

MarshalUtils()

Constructors
Constructor and Description
`MarshalUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`cleanString(String str, String regex, String replaceStr, String defaultStr)` It will remove all regex matches within the string.
`static String`	`cleanToDataSafe(String str)` Ensure String is without any special characters etc and all replaced characters are replaced with an underscore
`static <S,T> Collection<T>`	`convert(Collection<S> collection, MarshalUtils.GenericTransformer<S,T> valueTransformer)` Returns a new Collection with the modified types
`static <S,T> Collection<T>`	`convert(Collection<S> collection, MarshalUtils.GenericTransformer<S,T> valueTransformer, Collection<T> existingCollection)` Adds to an existing Collection with the modified types
`static <T> Collection<T>`	`convert(Collection<String> coll, MarshalUtils.Transformer<T> transformer)`
`static <X extends Enum,S,T> Map<X,T>`	`convert(Map<String,S> map, Class<X> xClass, MarshalUtils.GenericTransformer<S,T> valueTransformer)` Converts a Map with String, T type to generic type X, T.
`static <S,T> Map<String,T>`	`convert(Map<String,S> map, MarshalUtils.GenericTransformer<S,T> valueTransformer)` Returns a new map with the modified types
`static <X extends Enum,T> Map<X,T>`	`convert(Map<String,T> map, Class<X> xClass)` Converts a Map with String, T type to generic type X, T.
`static <X extends Enum,T> Map<String,T>`	`convert(Map<X,T> map)` Converts a Map with X, T generic type to String, T.
`static <S,T> Collection<T>`	`convertAndAddAll(Collection<S> collection, MarshalUtils.GenericTransformer<S,Collection<T>> valueTransformer, Collection<T> existingCollection)` Adds list elements of the return from a valueTransformer, to an existing Collection with the modified types
`static <T> Collection<String>`	`convertBack(Collection<T> coll, MarshalUtils.Transformer<T> transformer)`
`static Map<String,String>`	`convertKeyValueStrToMap(String keyValuePairs, String delimiter)`
`static <O,I> Map<O,Integer>`	`convertListToCountMap(List<I> list, Function<I,O> extractor)` If a List contains repeats, this method will marshal it into a Map, with each entity having a count of the number of instances in the list passed
`static String`	`decode(String s, String charSet)` Convenience use for simplified exception handling; handles the ususal Exceptions and nulls
`static String`	`displayFriendly(String str)` Convert Java Style camelCase to Spaced Words
`static String`	`encode(String s, String charSet)` Convenience use for simplified exception handling; handles the ususal Exceptions and nulls
`static String`	`escapeCommas(String str)`
`static String`	`exceptionTraceToString(Throwable t)`
`static <T> Collection<T>`	`filter(Collection<T> collection, org.apache.commons.collections.Predicate p)` Checks if Objects in the collection match the {@link Predicate; if they do they pass and are collected in the resultant output else they are filtered out.
`static <V,T> Collection<T>`	`filterAndTransform(Collection<V> collection, org.apache.commons.collections.Predicate p, MarshalUtils.GenericTransformer<V,T> transformer)` Checks if Objects in the collection match the {@link Predicate; if they do they pass and are collected in the resultant output else they are filtered out.
`static Map`	`flipMap(Map input)` Converts keys to value and value to Keys
`static <T extends Enum> MarshalUtils.Transformer<T>`	`getEnumTransformer(Class<T> enumClass)`
`static String`	`getHex(byte[] bytes)`
`static String`	`getSHA1DigestHash(byte[] dataBytes)` Get a HexaDecimal Hash Code (SHA1 Digest) for a stream of bytes
`static String`	`getSHA1DigestHash(InputStream in)` Get HEX String (SHA1 Digest) for the stream
`static String`	`getStringAtIndexFromDelimittedString(String delimittedStr, int index, String delimiter)` From a String that represents say a comma separated value or some other delimiter.
`static void`	`main(String... s)`
`static void`	`marshalToCollection(String rawString, Collection<String> collection)` Convenience method to extract a collection type of Strings from a delimited String (, or ; or new line) and each returned token will be trimmed. If the input is null then output is also null. The list is appended is the string that is converted.
`static void`	`marshalToCollection(String rawString, Collection collection, MarshalUtils.Transformer t)` Convenience method to extract a collection type of Strings from a delimited String (, or ; or new line) and each returned token will be trimmed. If the input is null then output is also null. The list is appended is the string that is converted.
`static String`	`marshalToJSON(Object o)`
`static <T> List<T>`	`marshalToList(String[] params, MarshalUtils.Transformer<T> transformer)` Convenience method to marshal array to Specific Type and each returned token will be trimmed. If the input is null then output is also null.
`static <T> List<T>`	`marshalToList(String rawString, MarshalUtils.Transformer<T> transformer)` Convenience method to extract a list of Objects from a delimited String (, or ;) and each returned token will be trimmed. If the input is null then output is also null.
`static String`	`marshalToString(Collection<?> coll, Character quot, MarshalUtils.Transformer t)` For a not null Collection of String's it will return a comma separated String, with the elements optionally quited if the element is not null.
`static String`	`normalize(String str)` If not null then normalize (by default this means lowercase)'
`static String`	`pad(String s, int digits, String pad)`
`static String`	`padZero(String s)` Default to 2 Digits (single padding)
`static String`	`prepareCSV(String input)` Convert a raw record to a format acceptable for CSV output
`static String`	`regexReplace(String input, MarshalUtils.Replacer replacer)` Replaces sub-sequences that match the RegEx in replacer with the dynamic ability of `MarshalUtils.Replacer.substitute(String)`.
`static String`	`replaceQueryParamsPlusSpace(String url)` Query params on encoding all spaces are converted to "+" unlike non Query params that are converted to %20.
`static String`	`sanitize(String str)` Ensure Any Content shown on Screen is sanitized for basic security & also remove formatting & markups before displaying it in a LISTING
`static String[]`	`splitAtCommas(String str)` Split the string as all non escaped comma locations
`static String`	`toAlphaNumeric(String str)` Strips out all non alpha numeric codes; underscores are left.
`static Set<String>`	`tokenize(List<String> strings, String tokenPatternDelimeter)` For a given List of String , tokenize each string based on tokenPatternDelimeter and return a unique Set of tokens.
`static <S,T> Map<S,T>`	`transform(Collection<T> list, org.apache.commons.collections.Transformer identifier)` Convert a List of generic type to a Map, with a String as an ID for each element in the List.
`static <V,T> Collection<T>`	`transform(Collection<V> params, T typeTemplate, MarshalUtils.GenericTransformer<V,T> transformer)`
`static <T,V> Collection<V>`	`transform(Map<T,V> map, org.apache.commons.collections.Predicate keyPredicate, org.apache.commons.collections.Predicate valuePredicate)` Convert Map values to a Collection; and optionally provide filters in the form of key & value predicates.
`static <V,T> Collection<T>`	`transform(V[] params, T typeTemplate, MarshalUtils.GenericTransformer<V,T> transformer)`
`static String`	`wrapJavaScript(String script)`

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

- Field Detail
  - CLEAN_ALL_EXCEPT_ALPHANUMERIC
```
public static String CLEAN_ALL_EXCEPT_ALPHANUMERIC
```
  - CLEAN_ALL_WITHSPACE_EXCEPT_ALPHANUMERIC
```
public static String CLEAN_ALL_WITHSPACE_EXCEPT_ALPHANUMERIC
```
  - NAME_PATTERN
```
public static String NAME_PATTERN
```
  - normalizer
```
public static MarshalUtils.Transformer normalizer
```
  - morphDynaBeanToAuthTransformer
```
public static final MarshalUtils.GenericTransformer<net.sf.ezmorph.bean.MorphDynaBean,Authorization> morphDynaBeanToAuthTransformer
```
  - jsonAuthTransformer
```
public static final MarshalUtils.GenericTransformer jsonAuthTransformer
```
  - hierarchyTransformer
```
public static org.apache.commons.collections.Transformer hierarchyTransformer
```
    Convert the List of HierarchialDomainObject to a Comma separated Query consumable String of hierarchies
    Usage :StringUtils.join(CollectionUtils.transformedCollection(List<HierarchialDomainObject>, this), ',')
  - parentIdTransformer
```
public static org.apache.commons.collections.Transformer parentIdTransformer
```
    Convert the List of HierarchialDomainObject to a Comma separated Query consumable String of parent Ids
    Usage :StringUtils.join(CollectionUtils.transformedCollection(List<HierarchialDomainObject>, this), ',')
- Constructor Detail
  - MarshalUtils
```
public MarshalUtils()
```
- Method Detail
  - toAlphaNumeric
```
public static String toAlphaNumeric(String str)
```
    Strips out all non alpha numeric codes; underscores are left.
    
    Parameters:
    
    str -
    
    Returns:
    
    String
  - cleanToDataSafe
```
public static String cleanToDataSafe(String str)
```
    Ensure String is without any special characters etc and all replaced characters are replaced with an underscore
  - cleanString
```
public static String cleanString(String str,
                                 String regex,
                                 String replaceStr,
                                 String defaultStr)
```
    It will remove all regex matches within the string. If str is null then def is returned & removes any control characters
    refer to some default constant expressions provided like CLEAN_ALL_EXCEPT_ALPHANUMERIC etc. If string is null default is returned
    
    Parameters:
    
    str - as String original input
    
    regex - as pattern to clean out
    
    replaceStr - as String replacement for all matching regex to be cleaned
    
    defaultStr - as String, default value if str is null
    
    Returns:
    
    String cleaned out
  - encode
```
public static String encode(String s,
                            String charSet)
```
    Convenience use for simplified exception handling; handles the ususal Exceptions and nulls
  - replaceQueryParamsPlusSpace
```
public static String replaceQueryParamsPlusSpace(String url)
```
    Query params on encoding all spaces are converted to "+" unlike non Query params that are converted to %20.
    This code converts the query params + spaces into %20 also.
    Call this function ONLY AFTER encoding is performed, so we know + means SPACE and not a +.
    
    Returns:
    
    String
  - main
```
public static void main(String... s)
```
  - decode
```
public static String decode(String s,
                            String charSet)
```
    Convenience use for simplified exception handling; handles the ususal Exceptions and nulls
  - displayFriendly
```
public static String displayFriendly(String str)
```
    Convert Java Style camelCase to Spaced Words
    
    Returns:
    
    String
  - marshalToList
```
public static <T> List<T> marshalToList(String rawString,
                                        MarshalUtils.Transformer<T> transformer)
```
    Convenience method to extract a list of Objects from a delimited String (, or ;) and each returned token will be trimmed.
    If the input is null then output is also null.
    
    Parameters:
    
    as - generic type MarshalUtils.Transformer
    
    rawString - as a , or ; or breaks (\r\n then \r then \n) delimeted String
    
    transformer - @nullable true
    
    Returns:
    
    List of Transformed Type
  - marshalToList
```
public static <T> List<T> marshalToList(String[] params,
                                        MarshalUtils.Transformer<T> transformer)
```
    Convenience method to marshal array to Specific Type and each returned token will be trimmed.
    If the input is null then output is also null.
    
    Parameters:
    
    as - generic type MarshalUtils.Transformer
    
    params - as Array of String
    
    Returns:
    
    List of Transformed Type
  - marshalToCollection
```
public static void marshalToCollection(String rawString,
                                       Collection<String> collection)
```
    Convenience method to extract a collection type of Strings from a delimited String (, or ; or new line) and each returned token will be trimmed.
    If the input is null then output is also null.
    The list is appended is the string that is converted.
    
    Parameters:
    
    rawString - as a , or ; or breaks (\r\n then \r then \n) delimited String
    
    as - Collection
  - marshalToCollection
```
public static void marshalToCollection(String rawString,
                                       Collection collection,
                                       MarshalUtils.Transformer t)
```
    Convenience method to extract a collection type of Strings from a delimited String (, or ; or new line) and each returned token will be trimmed.
    If the input is null then output is also null.
    The list is appended is the string that is converted.
    Parameters:
    
    rawString - as a , or ; or breaks (\r\n then \r then \n) delimited String
    as - Collection

Class MarshalUtils

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLEAN_ALL_EXCEPT_ALPHANUMERIC

CLEAN_ALL_WITHSPACE_EXCEPT_ALPHANUMERIC

NAME_PATTERN

normalizer

morphDynaBeanToAuthTransformer

jsonAuthTransformer

hierarchyTransformer

parentIdTransformer

Constructor Detail

MarshalUtils

Method Detail

toAlphaNumeric

cleanToDataSafe

cleanString

encode

replaceQueryParamsPlusSpace

main

decode

displayFriendly

marshalToList

marshalToList

marshalToCollection

marshalToCollection

convert

convertBack

getEnumTransformer

marshalToString

normalize

filter

filterAndTransform

transform

transform

transform

transform

regexReplace

convert

convert

convert

convertListToCountMap

convert

convert

convert

convertAndAddAll

flipMap

marshalToJSON

exceptionTraceToString

wrapJavaScript

getHex

getSHA1DigestHash

getSHA1DigestHash

escapeCommas

splitAtCommas

prepareCSV

padZero

pad

getStringAtIndexFromDelimittedString

sanitize

convertKeyValueStrToMap

tokenize