/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. 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.html
 * or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [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.
 */

/*
 * Nesting.java
 *
 * Created on March 8, 2000
 */

package com.sun.jdo.spi.persistence.support.sqlstore.query.util.scope;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

/**
 * This class is used to handle the hidden definition
 * of an identifier. If an identifier is declared its old 
 * definition is hidden and stored in the actual nesting.
 *
 * @author  Michael Bouschen
 * @version 0.1
 */
public class Nesting
{
    /**
     * List of idents with hidden definitions in the actual scope.
     */
    protected List idents;
    
    /**
     * List of hidden definitions; each definition in this list
     * corresponds to an identifier of the list idents.
     */
    protected List hiddenDefs;

    /**
     * Creates an new nesting.
     */
    public Nesting()
    {
        this.idents = new ArrayList();
        this.hiddenDefs = new ArrayList();
    }

    /**
     * Adds a hidden definition to this.
     * @param ident name of the identifier
     * @param hidden the hidden definition of ident
     */
    public void add(String ident, Definition hidden)
    {
        idents.add(ident);
        hiddenDefs.add(hidden);
    }

    /**
     * Returns an enumeration of idents with hidden definitions.
     */
    public Iterator getIdents()
    {
        return idents.iterator();
    }

    /**
     * Returns an enumeration of hidden definitions.
     */
    public Iterator getHiddenDefinitions()
    {
        return hiddenDefs.iterator();
    }
}
