XmlSerializable.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE 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.jackrabbit.webdav.xml;

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

/**
 * <code>XmlSerializable</code>...
 */
public interface XmlSerializable {

    /**
     * Returns the xml representation of the implementing object as
     * {@link org.w3c.dom.Element}. The given <code>Document</code> is used
     * as factory and represents the {@link org.w3c.dom.Element#getOwnerDocument()
     * owner document} of the returned DOM element.
     *
     * @return a w3c element representing this object
     * @param document to be used as factory.
     */
    public Element toXml(Document document);

}