/*

 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code 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

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.tools.internal.xjc.model;

import com.sun.codemodel.internal.JPackage;

/**

 * Parent of a {@link CClassInfo}/{@link CElementInfo}.

 *

 * TODO: rename

 *

 * Either {@link CClassInfo} or {@link CClassInfoParent.Package}.

 */

public interface CClassInfoParent {

    /**

     * Returns the fully-qualified name.

     */

    String fullName();

    <T> T accept( Visitor<T> visitor );

    /**

     * Gets the nearest {@link JPackage}.

     */

    JPackage getOwnerPackage();

    /**

     * Visitor of {@link CClassInfoParent}

     */

    public static interface Visitor<T> {

        T onBean( CClassInfo bean );

        T onPackage( JPackage pkg );

        T onElement( CElementInfo element );

    }

    /**

     * {@link JPackage} as a {@link CClassInfoParent}.

     *

     * Use {@link Model#getPackage} to obtain an instance.

     */

    public static final class Package implements CClassInfoParent {

        public final JPackage pkg;

        public Package(JPackage pkg) {

            this.pkg = pkg;

        }

        public String fullName() {

            return pkg.name();

        }

        public <T> T accept(Visitor<T> visitor) {

            return visitor.onPackage(pkg);

        }

        public JPackage getOwnerPackage() {

            return pkg;

        }

    }

}