com.github.fge.jackson

Class JsonLoader

java.lang.Object

com.github.fge.jackson.JsonLoader

public final class JsonLoader
extends Object

Utility class to load JSON values from various sources as JsonNodes.

This class uses a JsonNodeReader to parse JSON inputs.

See Also:

JsonNodeReader

Method Summary

Modifier and Type	Method and Description
static JsonNode	fromFile(File file) Same as fromPath(String), but this time the user supplies the File object instead
static JsonNode	fromPath(String path) Read a JsonNode from a file on the local filesystem.
static JsonNode	fromReader(Reader reader) Read a JsonNode from a user supplied Reader
static JsonNode	fromResource(String resource) Read a JsonNode from a resource path.
static JsonNode	fromString(String json) Read a JsonNode from a string input
static JsonNode	fromURL(URL url) Read a JsonNode from an URL.

Methods inherited from class java.lang.Object

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

Method Detail

fromResource

public static JsonNode fromResource(@Nonnull
                                    String resource)
                             throws IOException

Read a JsonNode from a resource path.

This method first tries and loads the resource using Class.getResource(String); if not found, is tries and uses the context classloader and if this is not found, this class's classloader.

This method throws an IOException if the resource does not exist.

Parameters:

resource - the path to the resource (must begin with a /)

Returns:

the JSON document at the resource

Throws:

IllegalArgumentException - resource path does not begin with a /

IOException - there was a problem loading the resource, or the JSON document is invalid

fromURL

public static JsonNode fromURL(URL url)
                        throws IOException

Read a JsonNode from an URL.

Parameters:

url - The URL to fetch the JSON document from

Returns:

The document at that URL

Throws:

IOException - in case of network problems etc.

fromPath

public static JsonNode fromPath(String path)
                         throws IOException

Read a JsonNode from a file on the local filesystem.

Parameters:

path - the path (relative or absolute) to the file

Returns:

the document in the file

Throws:

IOException - if this is not a file, if it cannot be read, etc.

fromFile

public static JsonNode fromFile(File file)
                         throws IOException

Same as fromPath(String), but this time the user supplies the File object instead

Parameters:

file - the File object

Returns:

The document

Throws:

IOException - in many cases!

fromReader

public static JsonNode fromReader(Reader reader)
                           throws IOException

Read a JsonNode from a user supplied Reader

Parameters:

reader - The reader

Returns:

the document

Throws:

IOException - if the reader has problems

fromString

public static JsonNode fromString(String json)
                           throws IOException

Read a JsonNode from a string input

Parameters:

json - the JSON as a string

Returns:

the document

Throws:

IOException - could not read from string