org.dominokit.jackson.ObjectWriter Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2013 Nicolas Morel
*
* 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 org.dominokit.jackson;
import org.dominokit.jackson.exception.JsonSerializationException;
/**
* Writes an object to JSON.
*
* Example :
*
*
* public class Person {
* public String firstName, lastName;
* public Person(String firstName, String lastName){
* this.firstName = firstName;
* this.lastName = lastName;
* }
* }
*
* public interface PersonWriter extends ObjectWriter<Person> {}
*
* PersonWriter writer = new PersonWriterImpl();
* String json = writer.write(new Person("Nicolas", "Morel"));
*
* json ==> {"firstName":"Nicolas","lastName":"Morel"}
*
*
* @param Type of the object to write
*/
public interface ObjectWriter {
/**
* Writes an object to JSON.
*
* @param value Object to write
* @return the JSON output
* @throws org.dominokit.jackson.exception.JsonSerializationException if an exception occurs while
* writing the output
*/
String write(T value) throws JsonSerializationException;
/**
* Writes an object to JSON.
*
* @param value Object to write
* @param ctx Context for the full writing process
* @return a {@link java.lang.String} object.
* @throws org.dominokit.jackson.exception.JsonSerializationException if an exception occurs while
* writing the output
*/
String write(T value, JsonSerializationContext ctx) throws JsonSerializationException;
/**
* getSerializer.
*
* @return a {@link org.dominokit.jackson.JsonSerializer} object.
*/
JsonSerializer getSerializer();
}