Convert (Concourse Java API)

Object
- Convert

```
public final class Convert
extends Object
```
A collection of functions to convert objects. The public API defined in Concourse uses certain objects for convenience that are not recognized by Thrift, so it is necessary to convert back and forth between different representations.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Convert.ResolvableLink` A special class that is used to indicate that the record(s) to which one or more `links` should point must be resolved by finding all records that match a criteria.

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static List<Multimap<String,Object>>`	`anyJsonToJava(String json)` Takes a JSON string representation of an object or an array of JSON objects and returns a list of `multimaps` with the corresponding data.
`static List<TObject>`	`javaListToThrift(List<Object> objects)` Return a List that represents the Thrift representation of each of the `objects` in the input list.
`static <K> Map<K,TObject>`	`javaMapToThrift(Map<K,Object> objects)` Return a Map that represents the Thrift representation of each of the `objects` in the input Map.
`static Set<TObject>`	`javaSetToThrift(Set<Object> objects)` Return a Set that represents the Thrift representation of each of the `objects` in the input Set.
`static TObject`	`javaToThrift(Object object)` Return the Thrift Object that represents `object`.
`static Multimap<String,Object>`	`jsonToJava(String json)` Convert a JSON formatted string to a mapping that associates each key with the Java objects that represent the corresponding values.
`static String`	`mapsToJson(Collection<Multimap<String,Object>> list)` Serialize the `list` of `maps` with data to a JSON string that can be batch inserted into Concourse.
`static String`	`mapToJson(Map<String,?> map)` Serialize the `map` of data as a JSON object string that can be inserted into Concourse.
`static String`	`mapToJson(Multimap<String,Object> map)` Serialize the `map` of a data as a JSON string that can inserted into Concourse.
`static String`	`operatorToString(Operator operator)` Convert the `operator` to a string representation.
`static <T> T`	`possibleThriftToJava(Object tobject)` For a scalar object that may be a `TObject` or a collection of other objects that may contain `TObjects`, convert to the appropriate java representation.
`static Object`	`stringToJava(String value)` Analyze `value` and convert it to the appropriate Java primitive or Object.
`static Operator`	`stringToOperator(String symbol)` Convert the `symbol` into the appropriate `Operator`.
`static String`	`stringToResolvableLinkInstruction(String ccl)` Users are encouraged to use `Link.toWhere(String)` instead of this method.
`static String`	`stringToResolvableLinkSpecification(String key, String rawValue)` Deprecated.
`static Set<Object>`	`thriftSetToJava(Set<TObject> tobjects)` Return a Set that represents the Java representation of each of the `TObjects` in the input Set.
`static Object`	`thriftToJava(TObject object)` Return the Java Object that represents `object`.

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

- Method Detail
  - anyJsonToJava
```
public static List<Multimap<String,Object>> anyJsonToJava(String json)
```
    Takes a JSON string representation of an object or an array of JSON objects and returns a list of multimaps with the corresponding data. Unlike jsonToJava(String), this method will allow the top level element to be an array in the {code json} string.
    
    Parameters:
    
    json -
    
    Returns:
    
    A list of Java objects
  - javaListToThrift
```
public static List<TObject> javaListToThrift(List<Object> objects)
```
    Return a List that represents the Thrift representation of each of the objects in the input list.
    
    Parameters:
    
    objects - a List of java objects
    
    Returns:
    
    a List of TObjects
  - javaMapToThrift
```
public static <K> Map<K,TObject> javaMapToThrift(Map<K,Object> objects)
```
    Return a Map that represents the Thrift representation of each of the objects in the input Map.
    
    Parameters:
    
    objects - a Map of java objects
    
    Returns:
    
    a Map of TObjects
  - javaSetToThrift
```
public static Set<TObject> javaSetToThrift(Set<Object> objects)
```
    Return a Set that represents the Thrift representation of each of the objects in the input Set.
    
    Parameters:
    
    objects - a Set of java objects
    
    Returns:
    
    a Set of TObjects
  - javaToThrift
```
public static TObject javaToThrift(Object object)
```
    Return the Thrift Object that represents object.
    
    Parameters:
    
    object -
    
    Returns:
    
    the TObject
  - jsonToJava
```
public static Multimap<String,Object> jsonToJava(String json)
```
    Convert a JSON formatted string to a mapping that associates each key with the Java objects that represent the corresponding values. This method is designed to parse simple JSON structures that associate keys to simple values or arrays without knowing the type of each element ahead of time.
    This method can properly handle JSON strings that abide by the following rules:
    - The top level element in the JSON string must be an Object
    - No nested objects (e.g. a key cannot map to an object)
    - No null values
    Parameters:
    
    json -
    
    Returns:
    
    the converted data
  - mapsToJson
```
public static String mapsToJson(Collection<Multimap<String,Object>> list)
```
    Serialize the list of maps with data to a JSON string that can be batch inserted into Concourse.
    
    Parameters:
    
    list - the list of data maps to include in the JSON object. This is meant to map to the return value of anyJsonToJava(String)
    
    Returns:
    
    the JSON string representation of the list
  - mapToJson
```
public static String mapToJson(Map<String,?> map)
```
    Serialize the map of data as a JSON object string that can be inserted into Concourse.
    
    Parameters:
    
    map - data to include in the JSON object.
    
    Returns:
    
    the JSON string representation of the map
  - mapToJson
```
public static String mapToJson(Multimap<String,Object> map)
```
    Serialize the map of a data as a JSON string that can inserted into Concourse.
    
    Parameters:
    
    map - the data to include in the JSON object. This is meant to map to the return value of jsonToJava(String)
    
    Returns:
    
    the JSON string representation of the map
  - operatorToString
```
public static String operatorToString(Operator operator)
```
    Convert the operator to a string representation.
    
    Parameters:
    
    operator -
    
    Returns:
    
    the operator string
  - possibleThriftToJava
```
public static <T> T possibleThriftToJava(Object tobject)
```
    For a scalar object that may be a TObject or a collection of other objects that may contain TObjects, convert to the appropriate java representation.
    
    Parameters:
    
    tobject - the possible TObject or collection of TObjects
    
    Returns:
    
    the java representation
  - stringToJava
```
public static Object stringToJava(String value)
```
    Analyze value and convert it to the appropriate Java primitive or Object.
    
    Conversion Rules
    - String - the value is converted to a string if it starts and ends with matching single (') or double ('') quotes. Alternatively, the value is converted to a string if it cannot be converted to another type
    - Convert.ResolvableLink - the value is converted to a ResolvableLink if it is a properly formatted specification returned from the stringToResolvableLinkSpecification(String, String) method (NOTE: this is a rare case)
    - Link - the value is converted to a Link if it is an int or long that is prepended by an '@' sign (i.e. @1234)
    - Boolean - the value is converted to a Boolean if it is equal to 'true', or 'false' regardless of case
    - Double - the value is converted to a double if and only if it is a decimal number that is immediately followed by a single capital "D" (e.g. 3.14D)
    - Tag - the value is converted to a Tag if it starts and ends with matching (`) quotes
    - Integer, Long, Float - the value is converted to a non double number depending upon whether it is a standard integer (e.g. less than 2147483647), a long, or a floating point decimal
    Parameters:
    
    value -
    
    Returns:
    
    the converted value
  - stringToOperator
```
public static Operator stringToOperator(String symbol)
```
    Convert the symbol into the appropriate Operator.
    
    Parameters:
    
    symbol - - the string form of a symbol (i.e. =, >, >=, etc) or a CaSH shortcut (i.e. eq, gt, gte, etc)
    
    Returns:
    
    the Operator that is parsed from the string symbol
  - stringToResolvableLinkInstruction
```
public static String stringToResolvableLinkInstruction(String ccl)
```
    Users are encouraged to use Link.toWhere(String) instead of this method.
    
    USE WITH CAUTION: This conversation is only necessary when bulk inserting data in string form (i.e. importing data from a CSV file) that should have static links dynamically resolved. Unless you are certain otherwise, you should never need to use this method because there is probably some intermediate function or framework that does this for you!
    
    Convert the ccl string to a Convert.ResolvableLink instruction for the receiver to add links to all the records that match the criteria.
    
    Please note that this method only returns a specification and not an actual Convert.ResolvableLink object. Use the stringToJava(String) method on the value returned from this method to get the object.
    
    Parameters:
    
    ccl - - The criteria to use when resolving link targets
    
    Returns:
    
    An instruction to create a Convert.ResolvableLink
  - stringToResolvableLinkSpecification
```
@Deprecated
public static String stringToResolvableLinkSpecification(String key,
                                                                     String rawValue)
```
    Deprecated.
    
    USE WITH CAUTION: This conversation is only necessary for applications that import raw data but cannot use the Concourse API directly and therefore cannot explicitly add links (e.g. the import-framework that handles raw string data). If you have access to the Concourse API, you should not use this method!
    Convert the rawValue into a Convert.ResolvableLink specification that instructs the receiver to add a link to all the records that have rawValue mapped from key.
    Please note that this method only returns a specification and not an actual Convert.ResolvableLink object. Use the stringToJava(String) method on the value returned from this method to get the object.
    
    Parameters:
    
    key -
    
    rawValue -
    
    Returns:
    
    the transformed value.
  - thriftSetToJava
```
public static Set<Object> thriftSetToJava(Set<TObject> tobjects)
```
    Return a Set that represents the Java representation of each of the TObjects in the input Set.
    
    Parameters:
    
    objects - a Set of TObjects
    
    Returns:
    
    a Set of Java objects
  - thriftToJava
```
public static Object thriftToJava(TObject object)
```
    Return the Java Object that represents object.
    
    Parameters:
    
    object -
    
    Returns:
    
    the Object

Class Convert

Nested Class Summary

Method Summary

Methods inherited from class Object

Method Detail

anyJsonToJava

javaListToThrift

javaMapToThrift

javaSetToThrift

javaToThrift

jsonToJava

mapsToJson

mapToJson

mapToJson

operatorToString

possibleThriftToJava

stringToJava

Conversion Rules

stringToOperator

stringToResolvableLinkInstruction

stringToResolvableLinkSpecification

thriftSetToJava

thriftToJava