com.owlike.genson.Converter Maven / Gradle / Ivy

Go to download
package com.owlike.genson;

import java.io.IOException;

import com.owlike.genson.stream.ObjectReader;

/**
 * Converter interface is a shorthand for classes who want to implement both serialization and
 * deserialization. You should always privilege Converter instead of low level Serializer and
 * Deseriliazer as they will be wrapped into a converter and all the ChainedFactory mechanism is
 * designed for converters. Here is an example of a Converter of URLs.
 * 
 * 
 * Genson genson = new Genson.Builder().with(new Converter<URL>() {
 *
 * 	@Override
 * 	public void serialize(URL url, ObjectWriter writer, Context ctx) {
 * 		// you don't have to worry about null objects, as the library will handle them.
 * 		writer.writeValue(obj.toExternalForm());
 *  }
 *
 * 	@Override
 * 	public URL deserialize(ObjectReader reader, Context ctx) {
 * 		return new URL(reader.valueAsString());
 *  }
 *
 * }).create();
 *
 * String serializedUrl = genson.serialize(new URL("http://www.google.com"));
 * URL url = genson.deserialize(serializedUrl, URL.class);
 * 
 * 
 * As you can see it is quite straightforward to create and register new Converters. Here is an
 * example dealing with more complex objects.
 *
 * @param  type of objects handled by this converter.
 * @author eugen
 */
public interface Converter extends Serializer, Deserializer {
  @Override
  public void serialize(T object, com.owlike.genson.stream.ObjectWriter writer, Context ctx) throws Exception;

  @Override
  public T deserialize(ObjectReader reader, Context ctx) throws Exception;
}