org.embulk.util.json

Class CapturingPointers.Builder

java.lang.Object

org.embulk.util.json.CapturingPointers.Builder

Enclosing class:

CapturingPointers

public static class CapturingPointers.Builder
extends Object

Builds CapturingPointers.

Method Summary

Modifier and Type	Method and Description
CapturingPointers.Builder	addDirectMemberName(String directMemberName) Adds a direct member name as a pointer to capture.
CapturingPointers.Builder	addJsonPointer(JsonPointer jsonPointer) Adds a JSON Pointer to capture.
CapturingPointers.Builder	addJsonPointer(String jsonPointer) Adds a JSON Pointer to capture.
CapturingPointers	build() Builds "capturing pointers".

Methods inherited from class java.lang.Object

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

Method Detail

addDirectMemberName

public CapturingPointers.Builder addDirectMemberName(String directMemberName)

Adds a direct member name as a pointer to capture.

It works only for a JSON object. It captures a JSON value that is directly under the root JSON object with the member name.

For example for the following JSON object {"foo": 12, "bar": 34, "baz": 56}, "foo" as a direct member name would capture 12, and "bar" would capture 34.

Parameters:

directMemberName - the direct member name to capture

Returns:

this builder

addJsonPointer

public CapturingPointers.Builder addJsonPointer(String jsonPointer)

Adds a JSON Pointer to capture.

It captures a JSON value that is pointed by the JSON Pointer.

For example for the following JSON object {"foo": {"bar": 12}, "baz": 56}, "/foo/bar" as a JSON Pointer would capture 12, and "/foo" would capture {"bar": 12}.

Parameters:

jsonPointer - the JSON Pointer to capture

Returns:

this builder

Throws:

IllegalArgumentException - if the input does not present a valid JSON Pointer expression

addJsonPointer

public CapturingPointers.Builder addJsonPointer(JsonPointer jsonPointer)

Adds a JSON Pointer to capture.

It captures a JSON value that is pointed by the JSON Pointer.

For example for the following JSON object {"foo": {"bar": 12}, "baz": 56}, "/foo/bar" as a JSON Pointer would capture 12, and "/foo" would capture {"bar": 12}.

Parameters:

jsonPointer - the JSON Pointer to capture

Returns:

this builder

build

public CapturingPointers build()

Builds "capturing pointers".

Returns:

the new capturing pointers