/*

 * 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.

 */

/*

 * Use is subject to the license terms.

 */

package com.sun.tools.internal.xjc.generator.bean;

import javax.xml.bind.annotation.XmlAccessType;

import javax.xml.bind.annotation.XmlEnum;

import javax.xml.bind.annotation.XmlEnumValue;

import com.sun.codemodel.internal.JClassContainer;

import com.sun.codemodel.internal.JDefinedClass;

import com.sun.codemodel.internal.JDocComment;

import com.sun.codemodel.internal.JMethod;

import com.sun.codemodel.internal.JMod;

import com.sun.codemodel.internal.JPackage;

import com.sun.codemodel.internal.JType;

import com.sun.codemodel.internal.JVar;

import com.sun.tools.internal.xjc.generator.annotation.spec.XmlAccessorTypeWriter;

import com.sun.tools.internal.xjc.model.CClassInfo;

import com.sun.tools.internal.xjc.outline.Aspect;

import com.sun.tools.internal.xjc.outline.Outline;

/**

 * Decides how a bean token is mapped to the generated classes.

 *

 * <p>

 * The actual implementations of this interface is tightly coupled with

 * the backend, but the front-end gets to choose which strategy to be used.

 *

 * @author Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

 */

@XmlEnum(Boolean.class)

public enum ImplStructureStrategy {

    /**

     * Generates beans only. The simplest code generation.

     */

    @XmlEnumValue("true")

    BEAN_ONLY() {

        protected Result createClasses(Outline outline, CClassInfo bean) {

            JClassContainer parent = outline.getContainer( bean.parent(), Aspect.EXPOSED );

            JDefinedClass impl = outline.getClassFactory().createClass(

                parent,

                JMod.PUBLIC|(parent.isPackage()?0:JMod.STATIC)|(bean.isAbstract()?JMod.ABSTRACT:0),

                bean.shortName, bean.getLocator() );

            impl.annotate2(XmlAccessorTypeWriter.class).value(XmlAccessType.FIELD);

            return new Result(impl,impl);

        }

        protected JPackage getPackage(JPackage pkg, Aspect a) {

            return pkg;

        }

        protected MethodWriter createMethodWriter(final ClassOutlineImpl target) {

            assert target.ref==target.implClass;

            return new MethodWriter(target) {

                private final JDefinedClass impl = target.implClass;

                private JMethod implMethod;

                public JVar addParameter(JType type, String name) {

                    return implMethod.param(type,name);

                }

                public JMethod declareMethod(JType returnType, String methodName) {

                    implMethod = impl.method( JMod.PUBLIC, returnType, methodName );

                    return implMethod;

                }

                public JDocComment javadoc() {

                    return implMethod.javadoc();

                }

            };

        }

        protected void _extends(ClassOutlineImpl derived, ClassOutlineImpl base) {

            derived.implClass._extends(base.implRef);

        }

    },

    /**

     * Generates the interfaces to describe beans (content interfaces)

     * and then the beans themselves in a hidden impl package.

     *

     * Similar to JAXB 1.0.

     */

    @XmlEnumValue("false")

    INTF_AND_IMPL() {

        protected Result createClasses( Outline outline, CClassInfo bean ) {

            JClassContainer parent = outline.getContainer( bean.parent(), Aspect.EXPOSED );

            JDefinedClass intf = outline.getClassFactory().createInterface(

                parent, bean.shortName, bean.getLocator() );

            parent = outline.getContainer(bean.parent(), Aspect.IMPLEMENTATION);

            JDefinedClass impl = outline.getClassFactory().createClass(

                parent,

                JMod.PUBLIC|(parent.isPackage()?0:JMod.STATIC)|(bean.isAbstract()?JMod.ABSTRACT:0),

                bean.shortName+"Impl", bean.getLocator() );

            impl.annotate2(XmlAccessorTypeWriter.class).value(XmlAccessType.FIELD);

            impl._implements(intf);

            return new Result(intf,impl);

        }

        protected JPackage getPackage(JPackage pkg, Aspect a) {

            switch(a) {

            case EXPOSED:

                return pkg;

            case IMPLEMENTATION:

                return pkg.subPackage("impl");

            default:

                assert false;

                throw new IllegalStateException();

            }

        }

        protected MethodWriter createMethodWriter(final ClassOutlineImpl target) {

            return new MethodWriter(target) {

                private final JDefinedClass intf = target.ref;

                private final JDefinedClass impl = target.implClass;

                private JMethod intfMethod;

                private JMethod implMethod;

                public JVar addParameter(JType type, String name) {

                    // TODO: do we still need to deal with the case where intf is null?

                    if(intf!=null)

                        intfMethod.param(type,name);

                    return implMethod.param(type,name);

                }

                public JMethod declareMethod(JType returnType, String methodName) {

                    if(intf!=null)

                        intfMethod = intf.method( 0, returnType, methodName );

                    implMethod = impl.method( JMod.PUBLIC, returnType, methodName );

                    return implMethod;

                }

                public JDocComment javadoc() {

                    if(intf!=null)

                        return intfMethod.javadoc();

                    else

                        return implMethod.javadoc();

                }

            };

        }

        protected void _extends(ClassOutlineImpl derived, ClassOutlineImpl base) {

            derived.implClass._extends(base.implRef);

            derived.ref._implements(base.ref);

        }

    };

    /**

     * Creates class(es) for the given bean.

     */

    protected abstract Result createClasses( Outline outline, CClassInfo bean );

    /**

     * Gets the specified aspect of the given package.

     */

    protected abstract JPackage getPackage( JPackage pkg, Aspect a );

    protected abstract MethodWriter createMethodWriter( ClassOutlineImpl target );

    /**

     * Sets up an inheritance relationship.

     */

    protected abstract void _extends( ClassOutlineImpl derived, ClassOutlineImpl base );

    public static final class Result {

        /**

         * Corresponds to {@link Aspect#EXPOSED}

         */

        public final JDefinedClass exposed;

        /**

         * Corresponds to {@link Aspect#IMPLEMENTATION}

         */

        public final JDefinedClass implementation;

        public Result(JDefinedClass exposed, JDefinedClass implementation) {

            this.exposed = exposed;

            this.implementation = implementation;

        }

    }

}