jsf/plugins/org.eclipse.jst.jsf.core/src/org/eclipse/jst/jsf/designtime/internal/view/ComponentConstructionData.java

/*******************************************************************************
 * Copyright (c) 2001, 2008 Oracle Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     Oracle Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jst.jsf.designtime.internal.view;

import org.eclipse.core.resources.IProject;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jst.jsf.common.runtime.internal.model.component.ComponentInfo;

/**
 * Encapsulates information required to construct a component
 * 
 * @author cbateman
 * 
 */
public class ComponentConstructionData
{
    private ComponentInfo _parent;
    private int _idCounter;
    private final IProject _project;
    private final IDocument _document;
    /**
     * @param idCounter
     * @param parent
     * @param project
     * @param document
     */
    public ComponentConstructionData(final int idCounter,
            final ComponentInfo parent, final IProject project, final IDocument document)
    {
        _parent = parent;
        _idCounter = idCounter;
        _project = project;
        _document = document;
    }

    /**
     * @return the parent id
     */
    public final ComponentInfo getParent()
    {
        return _parent;
    }

    /**
     * @return the id counter
     */
    public final int getIdCounter()
    {
        return _idCounter;
    }

    /**
     * Increment the counter by 1 and return the old value
     * 
     * @return the old value
     */
    public final int increment()
    {
        return _idCounter++;
    }

    /**
     * @param parent
     */
    public final void setParent(final ComponentInfo parent)
    {
        _parent = parent;
    }

    /**
     * @param idCounter
     */
    public final void setIdCounter(final int idCounter)
    {
        _idCounter = idCounter;
    }

    /**
     * @return the project that this component construction is associated with
     */
    public final IProject getProject()
    {
        return _project;
    }

    /**
     * @return the document context for the construction
     */
    public final IDocument getDocument()
    {
        return _document;
    }
    
}