/*
 *
 * Copyright (c) 1998 The Java Apache Project.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. Every modification must be notified to the Java Apache Project
 *    and redistribution of the modified code without prior notification
 *    is not permitted in any form.
 *
 * 4. All advertising materials mentioning features or use of this
 *    software must display the following acknowledgment:
 *    "This product includes software developed by the Java Apache Project
 *    (http://java.apache.org/)."
 *
 * 5. The names "Alexandria", "Apache Alexandria" and "Apache Alexandria
 *    Project" must not be used to endorse or promote products
 *    derived from this software without prior written permission.
 *
 * 6. Redistributions of any form whatsoever must retain the following
 *    acknowledgment:
 *    "This product includes software developed by the Java Apache Project
 *    (http://java.apache.org/)."
 *
 * THIS SOFTWARE IS PROVIDED BY THE JAVA APACHE PROJECT "AS IS" AND ANY
 * EXPRESSED 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 JAVA APACHE PROJECT OR
 * ITS 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.
 *
 * License version 1.0
 *
 */
package org.apache.maven.jxr.pacman;

import java.util.*;

/**
 * Interface for objects which wish to provide metainfo about a JavaFile.
 *
 * @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
 * @version $Id: JavaFile.java,v 1.1 2003/01/24 03:45:42 jvanzyl Exp $
 */
public abstract class JavaFile
{

    private Vector imports = new Vector();

    private ClassType classType = null;
    private PackageType packageType = new PackageType();

    private String filename = null;

    /** Get the imported packages/files that this package has.  */
    public ImportType[] getImportTypes()
    {

        ImportType[] it = new ImportType[this.imports.size()];
        this.imports.copyInto(it);
        return it;
    }

    /** Get the name of this class.  */
    public ClassType getClassType()
    {
        return this.classType;
    }

    /** Get the package of this class.  */
    public PackageType getPackageType()
    {
        return this.packageType;
    }


    /** Add an ImportType to the current imports  */
    public void addImportType(ImportType importType)
    {
        this.imports.addElement(importType);
    }

    /** Set the name of this class.  */
    public void setClassType(ClassType classType)
    {
        this.classType = classType;
    }

    /** Set the PackageType of this class.  */
    public void setPackageType(PackageType packageType)
    {
        this.packageType = packageType;
    }


    /** Gets the filename attribute of the JavaFile object */
    public String getFilename()
    {
        return this.filename;
    }

    /** Sets the filename attribute of the JavaFile object */
    public void setFilename(String filename)
    {
        this.filename = filename;
    }
}
