com.sun.org.apache.xml.internal.dtm.DTMAxisTraverser Maven / Gradle / Ivy
Show all versions of jaxp-ri Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* 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.
*/
/*
* $Id: DTMAxisTraverser.java,v 1.8 2010-11-01 04:34:34 joehw Exp $
*/
package com.sun.org.apache.xml.internal.dtm;
/**
* A class that implements traverses DTMAxisTraverser interface can traverse
* a set of nodes, usually as defined by an XPath axis. It is different from
* an iterator, because it does not need to hold state, and, in fact, must not
* hold any iteration-based state. It is meant to be implemented as an inner
* class of a DTM, and returned by the getAxisTraverser(final int axis)
* function.
*
* A DTMAxisTraverser can probably not traverse a reverse axis in
* document order.
*
* Typical usage:
*
* for(int nodeHandle=myTraverser.first(myContext);
* nodeHandle!=DTM.NULL;
* nodeHandle=myTraverser.next(myContext,nodeHandle))
* { ... processing for node indicated by nodeHandle goes here ... }
*
*
* @author Scott Boag
*/
public abstract class DTMAxisTraverser
{
/**
* By the nature of the stateless traversal, the context node can not be
* returned or the iteration will go into an infinate loop. So to traverse
* an axis, the first function must be used to get the first node.
*
* This method needs to be overloaded only by those axis that process
* the self node. <\p>
*
* @param context The context node of this traversal. This is the point
* that the traversal starts from.
* @return the first node in the traversal.
*/
public int first(int context)
{
return next(context, context);
}
/**
* By the nature of the stateless traversal, the context node can not be
* returned or the iteration will go into an infinate loop. So to traverse
* an axis, the first function must be used to get the first node.
*
*
This method needs to be overloaded only by those axis that process
* the self node. <\p>
*
* @param context The context node of this traversal. This is the point
* of origin for the traversal -- its "root node" or starting point.
* @param extendedTypeID The extended type ID that must match.
*
* @return the first node in the traversal.
*/
public int first(int context, int extendedTypeID)
{
return next(context, context, extendedTypeID);
}
/**
* Traverse to the next node after the current node.
*
* @param context The context node of this traversal. This is the point
* of origin for the traversal -- its "root node" or starting point.
* @param current The current node of the traversal. This is the last known
* location in the traversal, typically the node-handle returned by the
* previous traversal step. For the first traversal step, context
* should be set equal to current. Note that in order to test whether
* context is in the set, you must use the first() method instead.
*
* @return the next node in the iteration, or DTM.NULL.
* @see #first(int)
*/
public abstract int next(int context, int current);
/**
* Traverse to the next node after the current node that is matched
* by the extended type ID.
*
* @param context The context node of this traversal. This is the point
* of origin for the traversal -- its "root node" or starting point.
* @param current The current node of the traversal. This is the last known
* location in the traversal, typically the node-handle returned by the
* previous traversal step. For the first traversal step, context
* should be set equal to current. Note that in order to test whether
* context is in the set, you must use the first() method instead.
* @param extendedTypeID The extended type ID that must match.
*
* @return the next node in the iteration, or DTM.NULL.
* @see #first(int,int)
*/
public abstract int next(int context, int current, int extendedTypeID);
}