htsjdk.beta.io.bundle

Class BundleJSON

java.lang.Object

htsjdk.beta.io.bundle.BundleJSON

public class BundleJSON
extends java.lang.Object

Methods for serializing and deserializing Bundles to and from JSON strings.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BUNDLE_EXTENSION
static java.lang.String	JSON_PROPERTY_FORMAT
static java.lang.String	JSON_PROPERTY_PATH
static java.lang.String	JSON_PROPERTY_PRIMARY
static java.lang.String	JSON_PROPERTY_SCHEMA_NAME
static java.lang.String	JSON_PROPERTY_SCHEMA_VERSION
static java.lang.String	JSON_SCHEMA_NAME
static java.lang.String	JSON_SCHEMA_VERSION

Constructor Summary

Constructors

Constructor and Description
BundleJSON()

Method Summary

Modifier and Type	Method and Description
static Bundle	toBundle(java.lang.String jsonString) Create a Bundle from jsonString.
static <T extends IOPath> Bundle	toBundle(java.lang.String jsonString, java.util.function.Function<java.lang.String,T> ioPathConstructor) Create a Bundle from jsonString using a custom class that implements IOPath for all resources.
static java.lang.String	toJSON(Bundle bundle) Serialize this bundle to a JSON string representation.

Methods inherited from class java.lang.Object

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

Field Detail

BUNDLE_EXTENSION

public static final java.lang.String BUNDLE_EXTENSION

See Also:

Constant Field Values

JSON_PROPERTY_SCHEMA_NAME

public static final java.lang.String JSON_PROPERTY_SCHEMA_NAME

See Also:

Constant Field Values

JSON_PROPERTY_SCHEMA_VERSION

public static final java.lang.String JSON_PROPERTY_SCHEMA_VERSION

See Also:

Constant Field Values

JSON_PROPERTY_PRIMARY

public static final java.lang.String JSON_PROPERTY_PRIMARY

See Also:

Constant Field Values

JSON_PROPERTY_PATH

public static final java.lang.String JSON_PROPERTY_PATH

See Also:

Constant Field Values

JSON_PROPERTY_FORMAT

public static final java.lang.String JSON_PROPERTY_FORMAT

See Also:

Constant Field Values

JSON_SCHEMA_NAME

public static final java.lang.String JSON_SCHEMA_NAME

See Also:

Constant Field Values

JSON_SCHEMA_VERSION

public static final java.lang.String JSON_SCHEMA_VERSION

See Also:

Constant Field Values

Constructor Detail

BundleJSON

public BundleJSON()

Method Detail

toJSON

public static java.lang.String toJSON(Bundle bundle)

Serialize this bundle to a JSON string representation. All resources in the bundle must be IOPathResources for serialization to succeed. Stream resources cannot be serialized.

Parameters:

bundle - the Bundle to serialize to JSON

Returns:

a JSON string representation of this bundle

Throws:

java.lang.IllegalArgumentException - if any resource in bundle is not an IOPathResources.

toBundle

public static Bundle toBundle(java.lang.String jsonString)

Create a Bundle from jsonString.

Parameters:

jsonString - a valid JSON string conforming to the bundle schema

Returns:

a Bundle created from jsonString

toBundle

public static <T extends IOPath> Bundle toBundle(java.lang.String jsonString,
                                                 java.util.function.Function<java.lang.String,T> ioPathConstructor)

Create a Bundle from jsonString using a custom class that implements IOPath for all resources.

Type Parameters:

T - the IOPath-derived type to use for IOPathResources

Parameters:

jsonString - a valid JSON string conforming to the bundle schema

ioPathConstructor - a function that takes a string and returns an IOPath-derived class of type

Returns:

a newly created Bundle