org.sapia.util.xml.idefix.SerializerIF Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sapia_utils Show documentation

The newest version!

package org.sapia.util.xml.idefix;

import org.sapia.util.xml.Namespace;


/**
 *
 *
 * @author Jean-Cedric Desrochers
 * 
 * Copyright:
Copyright © 2002-2003 Sapia Open Source Software. All Rights Reserved.
 * License:
Read the license.txt file of the jar or visit the
 *        license page at the Sapia OSS web site
 * 
 */
public interface SerializerIF {
  /**
   * Transforms the object passed in into an XML representation. This method is called when the
   * object to transform is represents the root element of the XML document to create.
   *
   * @param anObject The object to serialize.
   * @param aContext The serialization context to use.
   * @exception SerializationException If an error occurs serializing the object.
   */
  public void serialize(Object anObject, SerializationContext aContext)
    throws SerializationException;

  /**
   * Transforms the object passed in into an XML representation. This method is called when the
   * object to transform is nested inside another object.
   *
   * @param anObject The object to serialize.
   * @param aNamespace The namespace of the object to serialize.
   * @param anObjectName The name of the object to serialize.
   * @param aContext The serialization context to use.
   * @exception SerializationException If an error occurs serializing the object.
   */
  public void serialize(Object anObject, Namespace aNamespace,
    String anObjectName, SerializationContext aContext)
    throws SerializationException;
}