You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
112 lines
3.9 KiB
112 lines
3.9 KiB
5 years ago
|
/*
|
||
|
|
* 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;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This interface is used by {@link ElementHandler}instances to retrieve
|
||
|
|
* information about the current path hierarchy they are to process. It's
|
||
|
|
* primary use is to retrieve the current {@link Element}being processed.
|
||
|
|
*
|
||
|
|
* @author <a href="mailto:dwhite@equipecom.com">Dave White </a>
|
||
|
|
* @version $Revision$
|
||
|
|
*/
|
||
|
|
public interface ElementPath {
|
||
|
|
/**
|
||
|
|
* DOCUMENT ME!
|
||
|
|
*
|
||
|
|
* @return the number of elements in the path
|
||
|
|
*/
|
||
|
|
int size();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* DOCUMENT ME!
|
||
|
|
*
|
||
|
|
* @param depth
|
||
|
|
* DOCUMENT ME!
|
||
|
|
*
|
||
|
|
* @return the element at the specified depth index, 0 = root element
|
||
|
|
*/
|
||
|
|
Element getElement(int depth);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* DOCUMENT ME!
|
||
|
|
*
|
||
|
|
* @return the path as a string
|
||
|
|
*/
|
||
|
|
String getPath();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* DOCUMENT ME!
|
||
|
|
*
|
||
|
|
* @return the current element
|
||
|
|
*/
|
||
|
|
Element getCurrent();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Adds the <code>ElementHandler</code> to be called when the specified
|
||
|
|
* path is encounted. The path can be either an absolute path (i.e. prefixed
|
||
|
|
* with "/") or a relative path (i.e. assummed to be a child of the current
|
||
|
|
* path as retrieved by <b>getPath </b>.
|
||
|
|
*
|
||
|
|
* @param path
|
||
|
|
* is the path to be handled
|
||
|
|
* @param handler
|
||
|
|
* is the <code>ElementHandler</code> to be called by the event
|
||
|
|
* based processor.
|
||
|
|
*/
|
||
|
|
void addHandler(String path, ElementHandler handler);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Removes the <code>ElementHandler</code> from the event based processor,
|
||
|
|
* for the specified path. The path can be either an absolute path (i.e.
|
||
|
|
* prefixed with "/") or a relative path (i.e. assummed to be a child of the
|
||
|
|
* current path as retrieved by <b>getPath </b>.
|
||
|
|
*
|
||
|
|
* @param path
|
||
|
|
* is the path to remove the <code>ElementHandler</code> for.
|
||
|
|
*/
|
||
|
|
void removeHandler(String path);
|
||
|
|
}
|
||
|
|
|
||
|
|
/*
|
||
|
|
* 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.
|
||
|
|
*/
|