• Home
• com.abubusoft
• kripton-core
• 3.5.0
• source code
• BinderContext.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.abubusoft.kripton.BinderContext Maven / Gradle / Ivy

package com.abubusoft.kripton;

import java.io.File;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Reader;
import java.io.Writer;
import java.util.Collection;
import java.util.List;
import java.util.Map;

/**
 * 

 * Binder context is interface used to define a persistence context. Every
 * persistence context allow to convert Java objects in specific data format and
 * viceversa.
 * 
 * 
 * @author Francesco Benincasa ([email protected])
 *
 */
/**
 * @author Francesco Benincasa ([email protected])
 *
 */
public interface BinderContext {

	/**
	 * return true if class can be persisted.
	 * 
	 * @param cls
	 * @return
	 */
	boolean canPersist(Class cls);

	/**
	 * 

	 * Specifies which data format is supported by this binding context.
	 * 
	 * 
	 * @return supported data format
	 */
	BinderType getSupportedFormat();

	/**
	 * 

	 * Parse a byte array to create an instance of objectClazz
	 * class.
	 * 
	 * 
	 * @param source
	 *            byte array as input
	 * @param objectClazz
	 *            class of object to create
	 * @return instance of object of type objectClazz
	 */
	 E parse(byte[] source, Class objectClazz);

	/**
	 * 

	 * Parse a file to create an instance of objectClazz class.
	 * 
	 * 
	 * @param source
	 *            input
	 * @param objectClazz
	 *            class of object to create
	 * @return instance of object of type objectClazz
	 */
	 E parse(File source, Class objectClazz);

	/**
	 * 

	 * Parse an input stream to create an instance of objectClazz
	 * class.
	 * 
	 * 
	 * @param source
	 *            input
	 * @param objectClazz
	 *            class of object to create
	 * @return instance of object of type objectClazz
	 */
	 E parse(InputStream source, Class objectClazz);

	/**
	 * 

	 * Use a reader to create an instance of objectClazz class.
	 * 
	 * 
	 * @param source
	 *            input
	 * @param objectClazz
	 *            class of object to create
	 * @return instance of object of type objectClazz
	 */
	 E parse(Reader source, Class objectClazz);

	/**
	 * 

	 * Parse a string to create an instance of objectClazz class.
	 * 
	 * 
	 * @param source
	 *            input
	 * @param objectClazz
	 *            class of object to create
	 * @return instance of object of type objectClazz
	 */
	 E parse(String buffer, Class objectClazz);

	/**
	 * 

	 * Parse a string to fill a collection of objectClazz instance.
	 * 
	 * 
	 * @param source
	 *            input
	 * @param collection
	 *            instance of collection to fill during parsing
	 * @param objectClazz
	 *            class of object to create
	 * @return collection of objects of type objectClazz. It's
	 *         equals to collection param.
	 */
	, E> L parseCollection(String source, L collection, Class objectClazz);

	/**
	 * 

	 * Parse a byte array to fill a collection of objectClazz
	 * instance.
	 * 
	 * 
	 * @param source
	 *            input
	 * @param collection
	 *            instance of collection to fill during parsing
	 * @param objectClazz
	 *            class of object to create
	 * @return collection of objects of type objectClazz. It's
	 *         equals to collection param.
	 */
	, E> L parseCollection(byte[] source, L collection, Class objectClazz);

	/**
	 * 

	 * Parse an inputstream to fill a collection of objectClazz
	 * instance.
	 * 
	 * 
	 * @param source
	 *            input
	 * @param collection
	 *            instance of collection to fill during parsing
	 * @param objectClazz
	 *            class of object to create
	 * @return collection of objects of type objectClazz. It's
	 *         equals to collection param.
	 */
	, E> L parseCollection(InputStream source, L collection, Class objectClazz);

	/**
	 * 

	 * Use a reader to fill a collection of objectClazz instance.
	 * 
	 * 
	 * @param source
	 *            input
	 * @param collection
	 *            instance of collection to fill during parsing
	 * @param objectClazz
	 *            class of object to create
	 * @return collection of objects of type objectClazz. It's
	 *         equals to collection param.
	 */
	, E> L parseCollection(Reader source, L collection, Class objectClazz);

	/**
	 * 

	 * Parse a byte array to create and populate a list of
	 * objectClazz instance.
	 * 
	 * 
	 * @param source
	 *            input
	 * @param objectClazz
	 *            class of object to create
	 * @return list of objects of type objectClazz
	 */
	 List parseList(byte[] source, Class objectClazz);

	/**
	 * 

	 * Parse a string to create and populate a list of objectClazz
	 * instance.
	 * 
	 * 
	 * @param source
	 *            input
	 * @param objectClazz
	 *            class of object to create
	 * @return list of objects of type objectClazz
	 */
	 List parseList(String source, Class objectClazz);

	/**
	 * 

	 * Parse a string to create and populate a map of key/value. The key is the
	 * name of field, value is its content.
	 * 
	 * 
	 * @param source
	 *            input
	 * @return map of key/value.
	 */
	Map parseMap(String source);

	/**
	 * 

	 * Parse an inputstream to create and populate a map of key/value. The key
	 * is the name of field, value is its content.
	 * 
	 * 
	 * @param source
	 *            input
	 * @return map of key/value.
	 */
	Map parseMap(InputStream source);

	/**
	 * 

	 * Use a reader to create and populate a map of key/value. The key is the
	 * name of field, value is its content.
	 * 
	 * 
	 * @param source
	 *            input
	 * @return map of key/value.
	 */
	Map parseMap(Reader source);

	/**
	 * 

	 * Parse a inputstream to create and populate a list of
	 * objectClazz instance.
	 * 
	 * 
	 * @param source
	 *            input
	 * @param objectClazz
	 *            class of object to create
	 * @return list of objects of type objectClazz
	 */
	 List parseList(InputStream source, Class objectClazz);

	/**
	 * 

	 * Use a reader to create and populate a list of objectClazz
	 * instance.
	 * 
	 * 
	 * @param source
	 *            input
	 * @param objectClazz
	 *            class of object to create
	 * @return list of objects of type objectClazz
	 */
	 List parseList(Reader source, Class objectClazz);

	/**
	 * 

	 * Serialize on a string the object passed as parameter. The used data
	 * format is the one supported by the binding context
	 * 
	 * 
	 * @param object
	 *            object to serialize
	 * @return output
	 */
	 String serialize(E object);

	/**
	 * 

	 * Serialize on a file the object passed as parameter. The used data format
	 * is the one supported by the binding context
	 * 
	 * 
	 * @param object
	 *            object to serialize
	 * @param output
	 *            output
	 */
	 void serialize(E object, File output);

	/**
	 * 

	 * Serialize on an outputstream the object passed as parameter. The used
	 * data format is the one supported by the binding context
	 * 
	 * 
	 * @param object
	 *            object to serialize
	 * @param output
	 *            output
	 */
	 void serialize(E object, OutputStream output);

	/**
	 * 

	 * Serialize on an writer the object passed as parameter. The used data
	 * format is the one supported by the binding context
	 * 
	 * 
	 * @param object
	 *            object to serialize
	 * @param output
	 *            output
	 */
	 void serialize(E object, Writer output);

	/**
	 * 

	 * Serialize a collection on a string. The used data format is the one
	 * supported by the binding context
	 * 
	 * 
	 * @param list
	 *            list to serialize
	 * @param objectClazz
	 *            type of object to persist
	 * 
	 * @return output
	 */
	 String serializeCollection(Collection list, Class objectClazz);

	/**
	 * 

	 * Serialize a collection on an output stream. The used data format is the
	 * one supported by the binding context
	 * 
	 * 
	 * @param list
	 *            list to serialize
	 * @param objectClazz
	 *            type of object to persist
	 * @param output
	 *            output
	 * 
	 */
	 void serializeCollection(Collection list, Class objectClazz, OutputStream output);

	/**
	 * 

	 * Serialize a collection on an file. The used data format is the one
	 * supported by the binding context
	 * 
	 * 
	 * @param list
	 *            list to serialize
	 * @param objectClazz
	 *            type of object to persist
	 * @param output
	 *            output
	 * 
	 */
	 void serializeCollection(Collection list, Class objectClazz, File output);

}