manifold.json.extensions.javax.script.Bindings

Class ManBindingsExt

java.lang.Object

manifold.json.extensions.javax.script.Bindings.ManBindingsExt

public class ManBindingsExt
extends Object

Extends Bindings with methods to transform the Bindings contents to JSON, YAML, and XML and to conveniently use the Bindings for JSON and YAML Web services.

Constructor Summary

Constructors

Constructor and Description
ManBindingsExt()

Method Summary

Modifier and Type	Method and Description
static Bindings	getJsonContent(Bindings thiz, String url) Get the content from the specified url using this Bindings as JSON-formatted arguments.
static Bindings	getYamlContent(Bindings thiz, String url) Get the content from the specified url using this Bindings as YAML-formatted arguments.
static String	listToJson(List list) Serializes a JSON-compatible List into a JSON formatted StringBuilder with the specified indent of spaces.
static void	listToJson(StringBuilder target, int indent, List value) Utility to serialize a List composed of JSON values, where a JSON value is one of: a simple type such as a String, number, or boolean a Bindings of property names to JSON values a List composed of JSON values
static String	makeArguments(Bindings arguments) Convert this Json Bindings to an arguments String suitable for a JSON-compatible URL.
static URL	makeUrl(Bindings thiz, String url) Make a JSON-compatible URL with the arguments from this Bindings.
static String	makeValue(Object value) Convert value to a String suitable for a JSON URL argument.
static Bindings	postForJsonContent(Bindings thiz, String url) Use HTTP POST to pass JSON bindings to this URL and get the full response as a JSON object.
static Bindings	postForYamlContent(Bindings thiz, String url) Use HTTP POST to pass JSON bindings to this URL and get the full response as a YAML object.
static String	toJson(Bindings thiz) Serializes this Bindings instance to a JSON formatted String
static void	toJson(Bindings thiz, StringBuilder target, int margin) Serializes this Bindings instance into a JSON formatted StringBuilder target with the specified indent of spaces.
static String	toXml(Bindings thiz) Serializes this Bindings instance to XML nested in a root element named "object"
static String	toXml(Bindings thiz, String name) Serializes this Bindings instance to XML with in a root element with the specified name
static void	toXml(Bindings thiz, String name, StringBuilder target, int indent) Serializes this Bindings instance into an XML formatted StringBuilder target with the specified indent of spaces.
static String	toYaml(Bindings thiz) Serializes this Bindings instance to a YAML formatted String
static void	toYaml(Bindings thiz, StringBuilder target) Serializes this Bindings instance into a YAML 1.2 formatted StringBuilder target with the specified indent of spaces.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManBindingsExt

public ManBindingsExt()

Method Detail

toJson

public static String toJson(Bindings thiz)

Serializes this Bindings instance to a JSON formatted String

Returns:

This Bindings instance serialized to a JSON formatted String

toYaml

public static String toYaml(Bindings thiz)

Serializes this Bindings instance to a YAML formatted String

Returns:

This Bindings instance serialized to a YAML formatted String

toJson

public static void toJson(Bindings thiz,
                          StringBuilder target,
                          int margin)

Serializes this Bindings instance into a JSON formatted StringBuilder target with the specified indent of spaces.

Parameters:

target - A StringBuilder to write the JSON in

margin - The margin of spaces to indent the resulting block of JSON

toYaml

public static void toYaml(Bindings thiz,
                          StringBuilder target)

Serializes this Bindings instance into a YAML 1.2 formatted StringBuilder target with the specified indent of spaces.

Parameters:

target - A StringBuilder to write the YAML in

listToJson

public static void listToJson(StringBuilder target,
                              int indent,
                              List value)

Utility to serialize a List composed of JSON values, where a JSON value is one of:

• a simple type such as a String, number, or boolean
• a Bindings of property names to JSON values
• a List composed of JSON values

Parameters:

target - A StringBuilder to write the JSON in

indent - The margin of spaces to indent the JSON

value - A List composed of JSON values to serialize

listToJson

public static String listToJson(List list)

Serializes a JSON-compatible List into a JSON formatted StringBuilder with the specified indent of spaces. Same as calling listToJson(StringBuilder, int, List) with no indentation and returns a String.

toXml

public static String toXml(Bindings thiz)

Serializes this Bindings instance to XML nested in a root element named "object"

See Also:

toXml(Bindings, String), toXml(Bindings, String, StringBuilder, int)

toXml

public static String toXml(Bindings thiz,
                           String name)

Serializes this Bindings instance to XML with in a root element with the specified name

Parameters:

name - The name of the root element to nest the Bindings XML

See Also:

toXml(Bindings, String, StringBuilder, int)

toXml

public static void toXml(Bindings thiz,
                         String name,
                         StringBuilder target,
                         int indent)

Serializes this Bindings instance into an XML formatted StringBuilder target with the specified indent of spaces.

Parameters:

name - The name of the root element to nest the Bindings XML

target - A StringBuilder to write the XML in

indent - The margin of spaces to indent the XML

makeUrl

public static URL makeUrl(Bindings thiz,
                          String url)

Make a JSON-compatible URL with the arguments from this Bindings. URL encodes the arguments in UTF-8 and appends them to the list using standard URL query delimiters.

If an argument is a Bindings or a List, it is transformed to JSON. Otherwise, the argument is coerced to a String and URL encoded.

Parameters:

url - The base URL to extend with encoded arguments from this Bindings

Returns:

The URL with JSON-encoded arguments from this Bindings

postForJsonContent

public static Bindings postForJsonContent(Bindings thiz,
                                          String url)

Use HTTP POST to pass JSON bindings to this URL and get the full response as a JSON object.

Returns:

The full content of this URL's stream as a JSON object.

See Also:

ManUrlExt.postForTextContent(URL, Bindings)

postForYamlContent

public static Bindings postForYamlContent(Bindings thiz,
                                          String url)

Use HTTP POST to pass JSON bindings to this URL and get the full response as a YAML object.

Returns:

The full content of this URL's stream as a YAML object.

See Also:

ManUrlExt.postForTextContent(URL, Bindings)

getJsonContent

public static Bindings getJsonContent(Bindings thiz,
                                      String url)

Get the content from the specified url using this Bindings as JSON-formatted arguments. Encodes the arguments in UTF-8 and appends them to the list using standard HTTP GET format.

This Bindings instance must be composed of property names mapped to JSON values. A JSON value is one of:

• a simple type such as a String, number, or boolean
• a Bindings of property names to JSON values
• a List composed of JSON values

If an argument is a Bindings or a List, it is transformed to JSON. Otherwise, the argument is coerced to a String and URL encoded.

Returns:

JSON bindings reflecting the content of the URL. Otherwise if the content is not JSON formatted, a RuntimeException results.

See Also:

postForJsonContent(Bindings, String), Json.fromJson(String)

getYamlContent

public static Bindings getYamlContent(Bindings thiz,
                                      String url)

Get the content from the specified url using this Bindings as YAML-formatted arguments. Encodes the arguments in UTF-8 and appends them to the list using standard HTTP GET format.

This Bindings instance must be composed of property names mapped to YAML values. A YAML value is one of:

• a simple type such as a String, number, or boolean
• a Bindings of property names to YAML values
• a List composed of YAML values

If an argument is a Bindings or a List, it is transformed to YAML. Otherwise, the argument is coerced to a String and URL encoded.

Returns:

YAML bindings reflecting the content of the URL. Otherwise if the content is not YAML formatted, a RuntimeException results.

See Also:

postForYamlContent(Bindings, String), Yaml.fromYaml(String)

makeArguments

public static String makeArguments(Bindings arguments)

Convert this Json Bindings to an arguments String suitable for a JSON-compatible URL.

Returns:

A String formatted with JSON-compatible URL arguments

makeValue

public static String makeValue(Object value)

Convert value to a String suitable for a JSON URL argument.

Parameters:

value - A JSON value. One of:

• a simple type such as a String, number, or boolean
• a Bindings of property names to JSON values
• a List composed of JSON values

Returns:

JSON formatted value String escaped for URL use.