org.projecthusky.xua.serialization.Serializer Maven / Gradle / Ivy

Go to download
/*
 * This code is made available under the terms of the Eclipse Public License v1.0 
 * in the github project https://github.com/project-husky/husky there you also 
 * find a list of the contributors and the license information.
 * 
 * This project has been developed further and modified by the joined working group Husky 
 * on the basis of the eHealth Connector opensource project from June 28, 2021, 
 * whereas medshare GmbH is the initial and main contributor/author of the eHealth Connector.
 *
 */
package org.projecthusky.xua.serialization;

import org.projecthusky.xua.exceptions.SerializeException;
import org.w3c.dom.Element;

/**
 * 
 * Typed interface describing some generic methods for serializing model instances to different serialized forms.
 * Typisiertes Interface welches die Methoden für die Serialisierung von Modell Instanzen in verschiedene Formen der Serialisierung beschreibt.
 * 
 * 
 *
 * @param 
 * the type of instance the methods should deal with.
 * der Typ der Instanz auf welchen die Methoden Anwendung finden.
 * 
 * 
 * 
 */
public interface Serializer {

	/**
	 * 
	 * Method to serialize the instance of T into an byte array.
	 * Methode um eine Instanz von T in ein Byte Array zu serialisieren.
	 * 
	 * 
	 *
	 * @param aSecurityObject
	 * the instance to be serialized
	 * die Instanz die serialisert werden soll
	 * 
	 * 
	 * @return
	 * the serialized instance as byte array
	 * die serialisierte Instanz als Byte Array
	 * 
	 * 
	 * @throws SerializeException
	 * will be thrown when an error occures serializing the object
	 *  wird geworfen wenn ein Fehler beim Serialisieren des Objektes auftritt
	 *  
	 *  
	 * 
	 */
	byte[] toXmlByteArray(T aSecurityObject) throws SerializeException;

	/**
	 * 
	 * Method to serialize the instance of T into an xml structure.
	 * Methode um eine Instanz von T in eine XML Struktur zu serialisieren.
	 * 
	 * 
	 *
	 * @param aSecurityObject
	 * the isntance to be serialized
	 * die Instanz die serialisert werden soll
	 * 
	 * 
	 * @return
	 * the serialized instance as xml structure
	 * die serialisierte Instanz als XML Struktur
	 * 
	 * 
	 * @throws SerializeException
	 * will be thrown when an error occures serializing the object
	 *  wird geworfen wenn ein Fehler beim Serialisieren des Objektes auftritt
	 *  
	 *  
	 * 
	 */
	Element toXmlElement(T aSecurityObject) throws SerializeException;

	/**
	 * 
	 * Method to serialize the instance of T into a string.
	 * Methode um eine Instanz von T in einen string zu serialisieren.
	 * 
	 * 
	 *
	 * @param aSecurityObject
	 * the instance to be serialized
	 * die Instanz die serialisert werden soll
	 * 
	 * 
	 * @return
	 * the serialized instance a string
	 * die serialisierte Instanz als string
	 * 
	 * 
	 * @throws SerializeException
	 * will be thrown when an error occures serializing the object
	 *  wird geworfen wenn ein Fehler beim Serialisieren des Objektes auftritt
	 *  
	 *  
	 * 
	 */
	String toXmlString(T aSecurityObject) throws SerializeException;

}