org.jaxen.util.FollowingSiblingAxisIterator Maven / Gradle / Ivy

Go to download
/*
 * $Header$
 * $Revision$
 * $Date$
 *
 * ====================================================================
 *
 * Copyright 2000-2002 bob mcwhirter & James Strachan.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 
 *   * 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.
 * 
 *   * Neither the name of the Jaxen Project nor the names of its
 *     contributors may be used to endorse or promote products derived 
 *     from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS 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 THE COPYRIGHT OWNER
 * OR 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.
 *
 * ====================================================================
 * This software consists of voluntary contributions made by many 
 * individuals on behalf of the Jaxen Project and was originally 
 * created by bob mcwhirter  and 
 * James Strachan .  For more information on the 
 * Jaxen Project, please see .
 * 
 * $Id$
 */



package org.jaxen.util;

import java.util.Iterator; 

import org.jaxen.JaxenConstants;
import org.jaxen.Navigator; 

/**
 * 
 * Represents the XPath following-sibling axis. 
 * The "following-sibling axis contains all the
 * folowing siblings of the context node; if the context node is an
 * attribute node or namespace node, the following-sibling
 * axis is empty."
 * 
 * @version 1.2b12
 *
 */
@SuppressWarnings({"rawtypes"})
public class FollowingSiblingAxisIterator implements Iterator
{
    private Object    contextNode;
    private Navigator navigator;
    private Iterator  siblingIter;

    /**
     * Create a new following-sibling axis iterator.
     * 
     * @param contextNode the node to start from
     * @param navigator the object model specific navigator
     */
    public FollowingSiblingAxisIterator(Object contextNode,
                                        Navigator navigator) 
    {
        this.contextNode = contextNode;
        this.navigator   = navigator;
        init();
    }

    private void init() 
    {
        Object parent = this.navigator.getParentNode( this.contextNode );

        if ( parent != null )
        {
            siblingIter = this.navigator.getChildAxisIterator( parent );
            
            while ( siblingIter.hasNext() )
            {
                Object eachChild = siblingIter.next();
                if ( eachChild.equals(this.contextNode) ) break;
            }
        }
        else {
            siblingIter = JaxenConstants.EMPTY_ITERATOR;
        }

    }
    
    /**
     * Returns true if there are any following siblings remain; false otherwise.
     * 
     * @return true if any following siblings remain; false otherwise
     * 
     * @see java.util.Iterator#hasNext()
     */
    public boolean hasNext()
    {
        return siblingIter.hasNext();
    }

    /**
     * Returns the next following sibling.
     * 
     * @return the next following sibling
     * 
     * @throws NoSuchElementException if no following siblings remain
     * 
     * @see java.util.Iterator#next()
     */
    public Object next()  
    {
        return siblingIter.next();
    }

    /**
     * This operation is not supported.
     * 
     * @throws UnsupportedOperationException always
     */
    public void remove() throws UnsupportedOperationException
    {
        throw new UnsupportedOperationException();
    }

}