package com.dbxml.xml;

/*
 * dbXML - Native XML Database
 * Copyright (C) 1999-2004  The dbXML Group, L.L.C.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * $Id: XMLSerializable.java,v 1.2 2004/02/12 00:17:58 bradford Exp $
 */

import org.w3c.dom.DOMException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;

/**
 * XMLSerializable is the interface that must be implemented by XMLSerializable
 * classes.  XMLSerializable classes are those classes whose state can be
 * retrieved and stored as XML DOM structures.
 */

public interface XMLSerializable {
   /**
    * streamToXML streams an object to XML.
    *
    * @param doc The Owner Document
    * @return A newly created Element
    * @throws DOMException If an error occurs
    */
   Element streamToXML(Document doc) throws DOMException;

   /**
    * streamFromXML streams an object from XML.
    *
    * @param element The Input Element
    * @throws DOMException If an error occurs
    */
   void streamFromXML(Element element) throws DOMException;
}
