0.8.1-rc1/commons/src/main/java/org/apache/oodt/commons/util/Documentable.java

// Licensed to the Apache Software Foundation (ASF) under one or more contributor
// license agreements.  See the NOTICE.txt file distributed with this work for
// additional information regarding copyright ownership.  The ASF licenses this
// file to you under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License.  You may obtain a copy of
// the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
// License for the specific language governing permissions and limitations under
// the License.

package org.apache.oodt.commons.util;

import java.io.*;
import java.util.*;
import org.w3c.dom.*;

/** A documentable object.
 *
 * An object that exhibits this interface can be documented, in XML, as a DOM node.
 *
 * @author Kelly.
 */
public interface Documentable {
	/** Document (aka serialize) this object into an XML DOM node.
	 *
	 * @param doc What document will own the node.
	 * @return This object as an XML DOM node.
	 * @throws DOMException If an error occurs while creating the DOM structure.
	 */
	Node toXML(Document doc) throws DOMException;
}