Ptidej-v5.2-master/JCT Utils/src/jct/util/IJCTContainer.java
/**
 * @author Mathieu Lemoine
 * @created 2008-08-16 (土)
 * 
 * Licensed under 3-clause BSD License:
 * Copyright © 2009, Mathieu Lemoine
 * 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 Mathieu Lemoine nor the
 *    names of contributors may be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY Mathieu Lemoine ''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 Mathieu Lemoine 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.
 */

package jct.util;

import java.util.Collection;

import jct.kernel.IJCTElement;
import jct.kernel.JCTKind;

/**
 * General-purpose interface for a Collection of JCT subtree.
 *
 * @author Mathieu Lemoine
 */
public interface IJCTContainer<Element extends IJCTElement>
{
    /**
     * Returns the Collection of Enclosed Elements
     */
    public Collection<Element> getEnclosedElements();

    /**
     * Returns the Collection of Enclosed Elements of type T
     */
    public <T extends Element> Collection<T> getEnclosedElements(Class<T> c);

    /**
     * Returns the Collection of directly and indirectly enclosed elements.
     */
    public Collection<? extends IJCTElement> getAllEnclosedElements();

    /**
     * Returns the Collection of directly and indirectly enclosed elements of kind K.
     * T must be compatible with K, otherwise behaviour is undefined.
     */
    public <T extends IJCTElement> Collection<T> getAllEnclosedElements(JCTKind K, Class<T> c, boolean first_layer_only);
}
