com.greenpepper.AbstractExample Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of greenpepper-remote-agent Show documentation
The newest version!
/*
 * Copyright (c) 2006 Pyxis Technologies inc.
 *
 * This is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA,
 * or see the FSF site: http://www.fsf.org.
 */
package com.greenpepper;

import com.greenpepper.util.ExampleUtil;

import java.util.Iterator;

/**
 * Abstract base class for Specification implementations. It
 * provides default implementations for some methods.
 *
 * @author oaouattara
 * @version $Id: $Id
 */
public abstract class AbstractExample implements Example
{
    /**
     * iterator.
     *
     * @return a {@link java.util.Iterator} object.
     */
    public Iterator iterator()
    {
        return new Iterator()
        {
            private int index = 0;

            public boolean hasNext()
            {
                return at( index ) != null;
            }

            public Example next()
            {
                return at( index++ );
            }

            public void remove()
            {
                throw new UnsupportedOperationException( "Specification not mutable" );
            }
        };
    }

    /**
     * hasSibling.
     *
     * @return a boolean.
     */
    public boolean hasSibling()
    {
        return nextSibling() != null;
    }

    /**
     * hasChild.
     *
     * @return a boolean.
     */
    public boolean hasChild()
    {
        return firstChild() != null;
    }

    /** {@inheritDoc} */
    public Example at(int i)
    {
        if (i == 0) return this;
        return hasSibling() ? nextSibling().at( i - 1 ) : null;
    }

    /**
     * at.
     *
     * @param i a int.
     * @param indexes a int.
     * @return a {@link com.greenpepper.Example} object.
     */
    public Example at(int i, int... indexes)
    {
        Example at = at( i );
        for (int j : indexes)
        {
            if (at == null || !at.hasChild())
                return null;
            at = at.firstChild().at( j );
        }
        return at;
    }

    /**
     * remainings.
     *
     * @return a int.
     */
    public int remainings()
    {
        return hasSibling() ? nextSibling().remainings() + 1 : 1;
    }

    /**
     * toString.
     *
     * @return a {@link java.lang.String} object.
     */
    public String toString()
    {
        return ExampleUtil.asString( this );
    }

    /**
     * lastSibling.
     *
     * @return a {@link com.greenpepper.Example} object.
     */
    public Example lastSibling()
    {
        return at( remainings() - 1 );
    }
}