io.github.astrapi69.json.ObjectToJsonExtensions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of json-extensions Show documentation
Useful extensions and utilities for convert java object to json and back with jackson
There is a newer version: 3.1
/**
 * The MIT License
 *
 * Copyright (C) 2015 Asterios Raptis
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package io.github.astrapi69.json;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.List;
import java.util.Objects;

import com.fasterxml.jackson.core.JsonGenerationException;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;

import io.github.astrapi69.json.factory.ObjectMapperFactory;

/**
 * The class {@link ObjectToJsonExtensions} converts java objects to json string objects.
 */
public final class ObjectToJsonExtensions
{

	private ObjectToJsonExtensions()
	{
	}

	/**
	 * Creates from the given {@link List} a json string
	 *
	 * @param 
	 *            the generic type
	 * @param list
	 *            the list
	 * @return the json string.
	 * @throws JsonGenerationException
	 *             If an error occurs by writing json string
	 * @throws JsonMappingException
	 *             the If an error occurs when mapping the string into Object
	 * @throws IOException
	 *             Signals that an I/O exception has occurred.
	 */
	public static  String toJson(final List list)
		throws JsonGenerationException, JsonMappingException, IOException
	{
		Objects.requireNonNull(list);
		final ObjectMapper mapper = ObjectMapperFactory.newObjectMapper();
		return toJson(list, mapper);
	}

	/**
	 * Creates from the given {@link List} a json string
	 *
	 * @param 
	 *            the generic type
	 * @param list
	 *            the list
	 * @param mapper
	 *            the object mapper
	 * @return the string
	 * @throws IOException
	 *             Signals that an I/O exception has occurred
	 * @throws JsonGenerationException
	 *             the json generation exception
	 * @throws JsonMappingException
	 *             the json mapping exception
	 */
	public static  String toJson(final List list, final ObjectMapper mapper)
		throws IOException, JsonGenerationException, JsonMappingException
	{
		Objects.requireNonNull(list);
		Objects.requireNonNull(mapper);
		final ByteArrayOutputStream out = new ByteArrayOutputStream();
		mapper.writeValue(out, list);

		out.close();
		return out.toString();
	}

	/**
	 * Creates a json {@link String} from the given argument object
	 *
	 * @param 
	 *            the generic type of the given argument object
	 * @param object
	 *            the object.
	 * @return the json string.
	 * @throws JsonProcessingException
	 *             If an error occurs when converting object to String
	 */
	public static  String toJson(final T object) throws JsonProcessingException
	{
		Objects.requireNonNull(object);
		return toJson(object, false);
	}

	/**
	 * Creates a json {@link String} from the given Object
	 *
	 * @param 
	 *            the generic type
	 * @param object
	 *            the object
	 * @param newMapper
	 *            flag that indicates if a new ObjectMapper should be created. if true a new
	 *            ObjectMapper will be created otherwise the ObjectMapper from this class will be
	 *            returned.
	 * @return the string
	 * @throws JsonProcessingException
	 *             If an error occurs when converting object to String
	 */
	public static  String toJson(final T object, final boolean newMapper)
		throws JsonProcessingException
	{
		Objects.requireNonNull(object);
		final ObjectMapper mapper = ObjectMapperFactory.newObjectMapper(newMapper);
		return toJson(object, mapper);
	}

	/**
	 * Creates a json {@link String} from the given Object and the given object mapper
	 *
	 * @param 
	 *            the generic type
	 * @param object
	 *            the object
	 * @param mapper
	 *            the object mapper
	 * @return the string
	 * @throws JsonProcessingException
	 *             the json processing exception
	 */
	public static  String toJson(final T object, final ObjectMapper mapper)
		throws JsonProcessingException
	{
		Objects.requireNonNull(object);
		Objects.requireNonNull(mapper);
		return mapper.writeValueAsString(object);
	}

}