com.speedment.common.json.Json Maven / Gradle / Ivy
Show all versions of tool-deploy Show documentation
/*
*
* Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"); You may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.common.json;
import com.speedment.common.json.internal.JsonDeserializer;
import com.speedment.common.json.internal.JsonSerializer;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
/**
* A utility class that can parse strings into ordinary java objects.
*
* JSON is parsed using the {@code RFC 7159} specification.
*
* @author Emil Forslund
* @since 1.0.0
*/
public final class Json {
private Json() {}
/**
* Parses the specified object to a JSON string. The following
* objects are supported:
*
* - {@code Map
}
* - {@code List
*
* This method will output a nicely formatted JSON string (with spaces and
* new-lines).
*
* @param object the object to parse
* @return the parsed string
*
* @throws IllegalArgumentException if the input object is a or contains
* unsupported types
*/
public static String toJson(Object object) {
try (final ByteArrayOutputStream out = new ByteArrayOutputStream()) {
toJson(object, out);
return new String(out.toByteArray(), StandardCharsets.UTF_8);
} catch (final IOException ex) {
throw new RuntimeException(
"Error in internal toString()-stream.", ex
);
}
}
/**
* Parses the specified object to JSON and prints it to the specified
* stream. The following objects are supported:
*
* - {@code Map
}
* - {@code List
*
* This method will output a nicely formatted JSON string (with spaces and
* new-lines).
*
* @param object the object to parse
* @param pretty if the result should be formatted in a pretty way
*
* @throws IllegalArgumentException if the input object is of or contains
* unsupported types
*/
public static String toJson(Object object, boolean pretty) {
try (final ByteArrayOutputStream out = new ByteArrayOutputStream()) {
toJson(object, out, pretty);
return new String(out.toByteArray(), StandardCharsets.UTF_8);
} catch (final IOException ex) {
throw new RuntimeException(
"Error in internal toString()-stream.", ex
);
}
}
/**
* Parses the specified object to JSON and prints it to the specified
* stream. The following objects are supported:
*
* - {@code Map
}
* - {@code List
*
* This method will output a nicely formatted JSON string (with spaces and
* new-lines).
*
* @param object the object to parse
* @param out the stream to write the result to
*
* @throws IllegalArgumentException if the inputed object is of or contains
* unsupported types
* @throws IOException if the stream could not be written to
*/
public static void toJson(Object object, OutputStream out) throws IOException {
toJson(object, out, true);
}
/**
* Parses the specified object to JSON and prints it to the specified
* stream. The following objects are supported:
*
* - {@code Map
}
* - {@code List
*
* This method will output a nicely formatted JSON string (with spaces and
* new-lines).
*
* @param object the object to parse
* @param out the stream to write the result to
* @param pretty if the result should be formatted in a pretty way
*
* @throws IllegalArgumentException if the input object is of or contains
* unsupported types
* @throws IOException if the stream could not be written to
*/
public static void toJson(Object object, OutputStream out, boolean pretty) throws IOException {
new JsonSerializer(out, pretty).print(object);
}
/**
* Parses the specified JSON string into a java object. The following
* objects are supported:
*
* - {@code Map
}
* - {@code List
*
* @param json the json to parse
* @return the created object
* @throws JsonSyntaxException if there is a syntax error
*/
public static Object fromJson(String json) {
try (final InputStream stream =
new ByteArrayInputStream(json.getBytes(StandardCharsets.UTF_8))) {
return fromJson(stream);
} catch (final IOException ex) {
throw new RuntimeException(ex);
}
}
/**
* Parses the specified JSON stream of unicode characters into a java
* object. The following objects are supported:
*
* - {@code Map
}
* - {@code List
*
* @param in the json to parse
* @return the created object
*
* @throws IOException if the stream can not be read
* @throws JsonSyntaxException if there is a syntax error
*/
public static Object fromJson(InputStream in) throws IOException {
try (final JsonDeserializer parser = new JsonDeserializer(in)) {
return parser.get();
}
}
}