com.yammer.dropwizard.json.Json Maven / Gradle / Ivy
package com.yammer.dropwizard.json;
import com.fasterxml.jackson.datatype.guava.GuavaModule;
import org.codehaus.jackson.*;
import org.codehaus.jackson.map.*;
import org.codehaus.jackson.map.type.TypeFactory;
import org.codehaus.jackson.type.JavaType;
import org.codehaus.jackson.type.TypeReference;
import java.io.*;
import java.lang.reflect.Type;
/**
* A basic class for JSON parsing and generating.
*
* By default, {@link Json} is configured to:
*
* - Automatically close JSON content, if possible.
* - Automatically close input and output streams.
* - Quote field names.
* - Allow both C-style line and block comments.
* - Not fail when encountering unknown properties.
* - Read and write enums using {@code toString()}.
* - Use {@code snake_case} for property names when encoding and decoding
* classes annotated with {@link JsonSnakeCase}.
*
*/
public class Json {
protected JsonFactory factory;
protected ObjectMapper mapper;
protected TypeFactory typeFactory;
/**
* Creates a new {@link Json} instance.
*/
public Json() {
this.factory = new MappingJsonFactory();
factory.enable(JsonGenerator.Feature.AUTO_CLOSE_JSON_CONTENT);
factory.enable(JsonGenerator.Feature.AUTO_CLOSE_TARGET);
factory.enable(JsonGenerator.Feature.QUOTE_FIELD_NAMES);
factory.enable(JsonParser.Feature.ALLOW_COMMENTS);
factory.enable(JsonParser.Feature.AUTO_CLOSE_SOURCE);
this.mapper = (ObjectMapper) factory.getCodec();
mapper.setPropertyNamingStrategy(AnnotationSensitivePropertyNamingStrategy.INSTANCE);
mapper.disable(DeserializationConfig.Feature.FAIL_ON_UNKNOWN_PROPERTIES);
mapper.disable(SerializationConfig.Feature.WRITE_ENUMS_USING_TO_STRING);
mapper.disable(DeserializationConfig.Feature.READ_ENUMS_USING_TO_STRING);
mapper.registerModule(new GuavaModule());
mapper.registerModule(new LogbackModule());
mapper.registerModule(new GuavaExtrasModule());
this.typeFactory = mapper.getTypeFactory();
}
/**
* Registers a module that can extend functionality provided by this class; for example, by
* adding providers for custom serializers and deserializers.
*
* @param module Module to register
* @see ObjectMapper#registerModule(org.codehaus.jackson.map.Module)
*/
public void registerModule(Module module) {
mapper.registerModule(module);
}
/**
* Returns true if the given {@link DeserializationConfig.Feature} is enabled.
*
* @param feature a given feature
* @return {@code true} if {@code feature} is enabled
* @see ObjectMapper#isEnabled(org.codehaus.jackson.map.DeserializationConfig.Feature)
*/
public boolean isEnabled(DeserializationConfig.Feature feature) {
return mapper.isEnabled(feature);
}
/**
* Enables the given {@link DeserializationConfig.Feature}s.
*
* @param features a set of features to enable
* @see ObjectMapper#enable(org.codehaus.jackson.map.DeserializationConfig.Feature...)
*/
public void enable(DeserializationConfig.Feature... features) {
mapper.enable(features);
}
/**
* Disables the given {@link DeserializationConfig.Feature}s.
*
* @param features a set of features to disable
* @see ObjectMapper#disable(org.codehaus.jackson.map.DeserializationConfig.Feature...)
*/
public void disable(DeserializationConfig.Feature... features) {
mapper.disable(features);
}
/**
* Returns true if the given {@link SerializationConfig.Feature} is enabled.
*
* @param feature a given feature
* @return {@code true} if {@code feature} is enabled
* @see ObjectMapper#isEnabled(org.codehaus.jackson.map.SerializationConfig.Feature)
*/
public boolean isEnabled(SerializationConfig.Feature feature) {
return mapper.isEnabled(feature);
}
/**
* Enables the given {@link SerializationConfig.Feature}s.
*
* @param features a set of features to enable
* @see ObjectMapper#enable(org.codehaus.jackson.map.SerializationConfig.Feature...)
*/
public void enable(SerializationConfig.Feature... features) {
mapper.enable(features);
}
/**
* Disables the given {@link SerializationConfig.Feature}s.
*
* @param features a set of features to disable
* @see ObjectMapper#disable(org.codehaus.jackson.map.SerializationConfig.Feature...)
*/
public void disable(SerializationConfig.Feature... features) {
mapper.disable(features);
}
/**
* Returns true if the given {@link JsonGenerator.Feature} is enabled.
*
* @param feature a given feature
* @return {@code true} if {@code feature} is enabled
* @see ObjectMapper#isEnabled(org.codehaus.jackson.JsonGenerator.Feature)
*/
public boolean isEnabled(JsonGenerator.Feature feature) {
return mapper.isEnabled(feature);
}
/**
* Enables the given {@link JsonGenerator.Feature}s.
*
* @param features a set of features to enable
* @see JsonFactory#enable(org.codehaus.jackson.JsonGenerator.Feature)
*/
public void enable(JsonGenerator.Feature... features) {
for (JsonGenerator.Feature feature : features) {
factory.enable(feature);
}
}
/**
* Disables the given {@link JsonGenerator.Feature}s.
*
* @param features a set of features to disable
* @see JsonFactory#disable(org.codehaus.jackson.JsonGenerator.Feature)
*/
public void disable(JsonGenerator.Feature... features) {
for (JsonGenerator.Feature feature : features) {
factory.disable(feature);
}
}
/**
* Returns true if the given {@link JsonParser.Feature} is enabled.
*
* @param feature a given feature
* @return {@code true} if {@code feature} is enabled
* @see ObjectMapper#isEnabled(org.codehaus.jackson.JsonParser.Feature)
*/
public boolean isEnabled(JsonParser.Feature feature) {
return mapper.isEnabled(feature);
}
/**
* Enables the given {@link JsonParser.Feature}s.
*
* @param features a set of features to enable
* @see JsonFactory#enable(org.codehaus.jackson.JsonParser.Feature)
*/
public void enable(JsonParser.Feature... features) {
for (JsonParser.Feature feature : features) {
factory.enable(feature);
}
}
/**
* Disables the given {@link JsonParser.Feature}s.
*
* @param features a set of features to disable
* @see JsonFactory#disable(org.codehaus.jackson.JsonParser.Feature)
*/
public void disable(JsonParser.Feature... features) {
for (JsonParser.Feature feature : features) {
factory.disable(feature);
}
}
/**
* Returns {@code true} if the mapper can find a serializer for instances of given class
* (potentially serializable), {@code false} otherwise (not serializable).
*
* @param type the type of object to serialize
* @return {@code true} if instances of {@code type} are potentially serializable
*/
public boolean canSerialize(Class type) {
return mapper.canSerialize(type);
}
/**
* Returns {@code true} if the mapper can find a deserializer for instances of given class
* (potentially deserializable), {@code false} otherwise (not deserializable).
*
* @param type the type of object to deserialize
* @return {@code true} if instances of {@code type} are potentially deserializable
*/
public boolean canDeserialize(Class type) {
return mapper.canDeserialize(constructType(type));
}
/**
* Deserializes the given {@link File} as an instance of the given type.
*
* @param src a JSON {@link File}
* @param valueType the {@link Class} to deserialize {@code src} as
* @param the type of {@code valueType}
* @return the contents of {@code src} as an instance of {@code T}
* @throws IOException if there is an error reading from {@code src} or parsing its contents
*/
public T readValue(File src, Class valueType) throws IOException {
return mapper.readValue(src, valueType);
}
/**
* Deserializes the given {@link File} as an instance of the given type.
*
* @param src a JSON {@link File}
* @param valueTypeRef a {@link TypeReference} of the type to deserialize {@code src} as
* @param the type of {@code valueTypeRef}
* @return the contents of {@code src} as an instance of {@code T}
* @throws IOException if there is an error reading from {@code src} or parsing its contents
*/
public T readValue(File src, TypeReference valueTypeRef) throws IOException {
return mapper.readValue(src, valueTypeRef);
}
/**
* Deserializes the given {@link String} as an instance of the given type.
*
* @param content a JSON {@link String}
* @param valueType the {@link Class} to deserialize {@code content} as
* @param the type of {@code valueType}
* @return {@code content} as an instance of {@code T}
* @throws IOException if there is an error parsing {@code content}
*/
public T readValue(String content, Class valueType) throws IOException {
return mapper.readValue(content, valueType);
}
/**
* Deserializes the given {@link String} as an instance of the given type.
*
* @param content a JSON {@link String}
* @param valueTypeRef a {@link TypeReference} of the type to deserialize {@code content} as
* @param the type of {@code valueTypeRef}
* @return {@code content} as an instance of {@code T}
* @throws IOException if there is an error parsing {@code content}
*/
public T readValue(String content, TypeReference valueTypeRef) throws IOException {
return mapper.readValue(content, valueTypeRef);
}
/**
* Deserializes the given {@link Reader} as an instance of the given type.
*
* @param src a JSON {@link Reader}
* @param valueType the {@link Class} to deserialize {@code src} as
* @param the type of {@code valueType}
* @return the contents of {@code src} as an instance of {@code T}
* @throws IOException if there is an error reading from {@code src} or parsing its contents
*/
public T readValue(Reader src, Class valueType) throws IOException {
return mapper.readValue(src, valueType);
}
/**
* Deserializes the given {@link Reader} as an instance of the given type.
*
* @param src a JSON {@link Reader}
* @param valueTypeRef a {@link TypeReference} of the type to deserialize {@code src} as
* @param the type of {@code valueTypeRef}
* @return the contents of {@code src} as an instance of {@code T}
* @throws IOException if there is an error reading from {@code src} or parsing its contents
*/
public T readValue(Reader src, TypeReference valueTypeRef) throws IOException {
return mapper.readValue(src, valueTypeRef);
}
/**
* Deserializes the given {@link InputStream} as an instance of the given type.
*
* @param src a JSON {@link InputStream}
* @param valueType the {@link Class} to deserialize {@code src} as
* @param the type of {@code valueType}
* @return the contents of {@code src} as an instance of {@code T}
* @throws IOException if there is an error reading from {@code src} or parsing its contents
*/
public T readValue(InputStream src, Class valueType) throws IOException {
return mapper.readValue(src, valueType);
}
/**
* Deserializes the given {@link InputStream} as an instance of the given type.
*
* @param src a JSON {@link InputStream}
* @param valueTypeRef a {@link TypeReference} of the type to deserialize {@code src} as
* @param the type of {@code valueTypeRef}
* @return the contents of {@code src} as an instance of {@code T}
* @throws IOException if there is an error reading from {@code src} or parsing its contents
*/
public T readValue(InputStream src, TypeReference valueTypeRef) throws IOException {
return mapper.readValue(src, valueTypeRef);
}
/**
* Deserializes the given {@link InputStream} as an instance of the given type.
*
* @param src a JSON {@link InputStream}
* @param valueType the {@link Type} to deserialize {@code src} as
* @param the type of {@code valueType}
* @return the contents of {@code src} as an instance of {@code T}
* @throws IOException if there is an error reading from {@code src} or parsing its contents
*/
public T readValue(InputStream src, Type valueType) throws IOException {
return mapper.readValue(src, constructType(valueType));
}
/**
* Deserializes the given byte array as an instance of the given type.
*
* @param src a JSON byte array
* @param valueType the {@link Class} to deserialize {@code src} as
* @param the type of {@code valueType}
* @return the contents of {@code src} as an instance of {@code T}
* @throws IOException if there is an error parsing {@code src}
*/
public T readValue(byte[] src, Class valueType) throws IOException {
return mapper.readValue(src, valueType);
}
/**
* Deserializes a subset of the given byte array as an instance of the given type.
*
* @param src a JSON byte array
* @param offset the offset into {@code src} of the subset
* @param len the length of the subset of {@code src}
* @param valueType the {@link Class} to deserialize {@code src} as
* @param the type of {@code valueType}
* @return the contents of {@code src} as an instance of {@code T}
* @throws IOException if there is an error parsing {@code src}
*/
public T readValue(byte[] src, int offset, int len, Class valueType) throws IOException {
return mapper.readValue(src, offset, len, valueType);
}
/**
* Deserializes the given byte array as an instance of the given type.
*
* @param src a JSON byte array
* @param valueTypeRef a {@link TypeReference} of the type to deserialize {@code src} as
* @param the type of {@code valueTypeRef}
* @return the contents of {@code src} as an instance of {@code T}
* @throws IOException if there is an error parsing {@code src}
*/
public T readValue(byte[] src, TypeReference valueTypeRef) throws IOException {
return mapper.readValue(src, valueTypeRef);
}
/**
* Deserializes a subset of the given byte array as an instance of the given type.
*
* @param src a JSON byte array
* @param offset the offset into {@code src} of the subset
* @param len the length of the subset of {@code src}
* @param valueTypeRef a {@link TypeReference} of the type to deserialize {@code src} as
* @param the type of {@code valueTypeRef}
* @return the contents of {@code src} as an instance of {@code T}
* @throws IOException if there is an error parsing {@code src}
*/
public T readValue(byte[] src, int offset, int len, TypeReference valueTypeRef) throws IOException {
return mapper.readValue(src, offset, len, valueTypeRef);
}
/**
* Deserializes the given {@link JsonNode} as an instance of the given type.
*
* @param root a {@link JsonNode}
* @param valueType the {@link Class} to deserialize {@code src} as
* @param the type of {@code valueType}
* @return the contents of {@code src} as an instance of {@code T}
* @throws IOException if there is an error mapping {@code src} to {@code T}
*/
public T readValue(JsonNode root, Class valueType) throws IOException {
return mapper.readValue(root, valueType);
}
/**
* Deserializes the given {@link JsonNode} as an instance of the given type.
*
* @param root a {@link JsonNode}
* @param valueTypeRef a {@link TypeReference} of the type to deserialize {@code src} as
* @param the type of {@code valueTypeRef}
* @return the contents of {@code src} as an instance of {@code T}
* @throws IOException if there is an error mapping {@code src} to {@code T}
*/
public T readValue(JsonNode root, TypeReference valueTypeRef) throws IOException {
return mapper.readValue(root, valueTypeRef);
}
/**
* Serializes the given object to the given {@link File}.
*
* @param output the {@link File} to which the JSON will be written
* @param value the object to serialize into {@code output}
* @throws IOException if there is an error writing to {@code output} or serializing {@code
* value}
*/
public void writeValue(File output, Object value) throws IOException {
mapper.writeValue(output, value);
}
/**
* Serializes the given object to the given {@link OutputStream}.
*
* @param output the {@link OutputStream} to which the JSON will be written
* @param value the object to serialize into {@code output}
* @throws IOException if there is an error writing to {@code output} or serializing {@code
* value}
*/
public void writeValue(OutputStream output, Object value) throws IOException {
mapper.writeValue(output, value);
}
/**
* Serializes the given object to the given {@link Writer}.
*
* @param output the {@link Writer} to which the JSON will be written
* @param value the object to serialize into {@code output}
* @throws IOException if there is an error writing to {@code output} or serializing {@code
* value}
*/
public void writeValue(Writer output, Object value) throws IOException {
mapper.writeValue(output, value);
}
/**
* Returns the given object as a JSON string.
*
* @param value an object
* @return {@code value} as a JSON string
* @throws IllegalArgumentException if there is an error encoding {@code value}
*/
public String writeValueAsString(Object value) throws IllegalArgumentException {
try {
return mapper.writeValueAsString(value);
} catch (IOException e) {
throw new IllegalArgumentException(e);
}
}
/**
* Returns the given object as a JSON byte array.
*
* @param value an object
* @return {@code value} as a JSON byte array
* @throws IllegalArgumentException if there is an error encoding {@code value}
*/
public byte[] writeValueAsBytes(Object value) throws IllegalArgumentException {
try {
return mapper.writeValueAsBytes(value);
} catch (IOException e) {
throw new IllegalArgumentException(e);
}
}
/**
* Returns the given object as a {@link JsonNode}.
*
* @param value an object
* @return {@code value} as a {@link JsonNode}
* @throws IllegalArgumentException if there is an error encoding {@code value}
*/
public JsonNode writeValueAsTree(Object value) throws IllegalArgumentException {
return mapper.valueToTree(value);
}
/**
* Deserializes the given YAML {@link File} as an instance of the given type.
* N.B.: All tags, comments, and non-JSON elements of the YAML file will be elided.
*
* @param src a YAML {@link File}
* @param valueType the {@link Class} to deserialize {@code src} as
* @param the type of {@code valueType}
* @return the contents of {@code src} as an instance of {@code T}
* @throws IOException if there is an error reading from {@code src} or parsing its contents
*/
public T readYamlValue(File src, Class valueType) throws IOException {
final YamlConverter converter = new YamlConverter(this, factory);
return mapper.readValue(converter.convert(src), valueType);
}
/**
* Deserializes the given YAML {@link File} as an instance of the given type.
* N.B.: All tags, comments, and non-JSON elements of the YAML file will be elided.
*
* @param src a YAML {@link File}
* @param valueTypeRef a {@link TypeReference} of the type to deserialize {@code src} as
* @param the type of {@code valueTypeRef}
* @return the contents of {@code src} as an instance of {@code T}
* @throws IOException if there is an error reading from {@code src} or parsing its contents
*/
public T readYamlValue(File src, TypeReference valueTypeRef) throws IOException {
final YamlConverter converter = new YamlConverter(this, factory);
return mapper.readValue(converter.convert(src), valueTypeRef);
}
private JavaType constructType(Type type) {
return typeFactory.constructType(type);
}
}