1 /*
   2  * reserved comment block
   3  * DO NOT REMOVE OR ALTER!
   4  */
   5 /*
   6  * Copyright 1999-2004 The Apache Software Foundation.
   7  *
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at

  11  *
  12  *     http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  */
  20 /*
  21  * $Id: DTMAxisTraverser.java,v 1.2.4.1 2005/09/15 08:14:52 suresh_emailid Exp $
  22  */
  23 package com.sun.org.apache.xml.internal.dtm;
  24 
  25 /**
  26  * A class that implements traverses DTMAxisTraverser interface can traverse
  27  * a set of nodes, usually as defined by an XPath axis.  It is different from
  28  * an iterator, because it does not need to hold state, and, in fact, must not
  29  * hold any iteration-based state.  It is meant to be implemented as an inner
  30  * class of a DTM, and returned by the getAxisTraverser(final int axis)
  31  * function.
  32  *
  33  * <p>A DTMAxisTraverser can probably not traverse a reverse axis in
  34  * document order.</p>
  35  *
  36  * <p>Typical usage:</p>
  37  * <pre><code>
  38  * for(int nodeHandle=myTraverser.first(myContext);
  39  *     nodeHandle!=DTM.NULL;
  40  *     nodeHandle=myTraverser.next(myContext,nodeHandle))
  41  * { ... processing for node indicated by nodeHandle goes here ... }
  42  * </code></pre>

   1 /*
   2  * reserved comment block
   3  * DO NOT REMOVE OR ALTER!
   4  */
   5 /*
   6  * Licensed to the Apache Software Foundation (ASF) under one or more
   7  * contributor license agreements.  See the NOTICE file distributed with
   8  * this work for additional information regarding copyright ownership.
   9  * The ASF licenses this file to You under the Apache License, Version 2.0
  10  * (the "License"); you may not use this file except in compliance with
  11  * the License.  You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  */
  21 


  22 package com.sun.org.apache.xml.internal.dtm;
  23 
  24 /**
  25  * A class that implements traverses DTMAxisTraverser interface can traverse
  26  * a set of nodes, usually as defined by an XPath axis.  It is different from
  27  * an iterator, because it does not need to hold state, and, in fact, must not
  28  * hold any iteration-based state.  It is meant to be implemented as an inner
  29  * class of a DTM, and returned by the getAxisTraverser(final int axis)
  30  * function.
  31  *
  32  * <p>A DTMAxisTraverser can probably not traverse a reverse axis in
  33  * document order.</p>
  34  *
  35  * <p>Typical usage:</p>
  36  * <pre><code>
  37  * for(int nodeHandle=myTraverser.first(myContext);
  38  *     nodeHandle!=DTM.NULL;
  39  *     nodeHandle=myTraverser.next(myContext,nodeHandle))
  40  * { ... processing for node indicated by nodeHandle goes here ... }
  41  * </code></pre>