org.dom4j.io.ElementModifier.java Source code

Introduction

Here is the source code for org.dom4j.io.ElementModifier.java

Source

/*
 * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
 *
 * This software is open source.
 * See the bottom of this file for the licence.
 */

package org.dom4j.io;

import org.dom4j.Element;

/**
 * ElementModifier defines a modifier of {@link org.dom4j.Element}objects. <br>
 * It can be used in the event based {@link org.dom4j.io.SAXModifier}, in order
 * to modify elements on the fly, rather than waiting until the complete
 * document is parsed.
 * 
 * @author Wonne Keysers (Realsoftware.be)
 */
public interface ElementModifier {
    /**
     * Called by an event based processor when an elements closing tag is
     * encountered. This method must return the modified version of the provided
     * {@link org.dom4j.Element}or null if it has to be removed from the
     * document. <br>
     * The incoming {@link org.dom4j.Element}is disconnected from the DOM4J
     * tree. This means that navigation to the elements parent {@link
     * org.dom4j.Element} and {@link org.dom4j.Document}are not available. Only
     * the element itself can be modified!
     * 
     * @param element
     *            {@link org.dom4j.Element}to be parsed
     * 
     * @return the modified {@link org.dom4j.Element}
     * 
     * @throws Exception
     *             of any kind
     */
    Element modifyElement(Element element) throws Exception;
}

/*
 * Redistribution and use of this software and associated documentation
 * ("Software"), with or without modification, are permitted provided that the
 * following conditions are met:
 * 
 * 1. Redistributions of source code must retain copyright statements and
 * notices. Redistributions must also contain a copy of this document.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * 
 * 3. The name "DOM4J" must not be used to endorse or promote products derived
 * from this Software without prior written permission of MetaStuff, Ltd. For
 * written permission, please contact dom4j-info@metastuff.com.
 * 
 * 4. Products derived from this Software may not be called "DOM4J" nor may
 * "DOM4J" appear in their names without prior written permission of MetaStuff,
 * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
 * 
 * 5. Due credit should be given to the DOM4J Project - http://www.dom4j.org
 * 
 * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
 */