/*

 * 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 java.util.Collection;

import javax.activation.MimeType;

import javax.xml.namespace.QName;

import com.sun.codemodel.internal.JClass;

import com.sun.codemodel.internal.JExpression;

import com.sun.tools.internal.xjc.model.nav.NClass;

import com.sun.tools.internal.xjc.model.nav.NType;

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

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

import com.sun.xml.internal.bind.v2.model.annotation.Locatable;

import com.sun.xml.internal.bind.v2.model.core.EnumLeafInfo;

import com.sun.xml.internal.bind.v2.model.core.ID;

import com.sun.xml.internal.bind.v2.model.core.NonElement;

import com.sun.xml.internal.bind.v2.model.core.Element;

import com.sun.xml.internal.bind.v2.runtime.Location;

import com.sun.xml.internal.xsom.XSComponent;

import com.sun.xml.internal.xsom.XmlString;

import org.xml.sax.Locator;

/**

 * Transducer that converts a string into an "enumeration class."

 *

 * The structure of the generated class needs to precisely

 * follow the JAXB spec.

 *

 * @author

 *    <a href="mailto:kohsuke.kawaguchi@sun.com">Kohsuke KAWAGUCHI</a>

 */

public final class CEnumLeafInfo implements EnumLeafInfo<NType,NClass>, NClass, CNonElement

{

    /**

     * The {@link Model} object to which this bean belongs.

     */

    public final Model model;

    /**

     * The parent into which the enum class should be generated.

     */

    public final CClassInfoParent parent;

    /**

     * Short name of the generated type-safe enum.

     */

    public final String shortName;

    private final QName typeName;

    private final XSComponent source;

    /**

     * Represents the underlying type of this enumeration

     * and its conversion.

     *

     * <p>

     * To parse XML into a constant, we use the base type

     * to do lexical -> value, then use a map to pick up the right one.

     *

     * <p>

     * Hence this also represents the type of the Java value.

     * For example, if this is an enumeration of xs:int,

     * then this field will be Java int.

     */

    public final CNonElement base;

    /**

     * List of enum members.

     */

    public final Collection<CEnumConstant> members;

    private final CCustomizations customizations;

    /**

     * @see #getLocator()

     */

    private final Locator sourceLocator;

    public String javadoc;

    public CEnumLeafInfo(Model model,

                         QName typeName,

                         CClassInfoParent container,

                         String shortName,

                         CNonElement base,

                         Collection<CEnumConstant> _members,

                         XSComponent source,

                         CCustomizations customizations,

                         Locator _sourceLocator) {

        this.model = model;

        this.parent = container;

        this.shortName = model.allocator.assignClassName(parent,shortName);

        this.base = base;

        this.members = _members;

        this.source = source;

        if(customizations==null)

            customizations = CCustomizations.EMPTY;

        this.customizations = customizations;

        this.sourceLocator = _sourceLocator;

        this.typeName = typeName;

        for( CEnumConstant mem : members )

            mem.setParent(this);

        model.add(this);

        // TODO: can we take advantage of the fact that enum can be XmlRootElement?

    }

    /**

     * Source line information that points to the place

     * where this type-safe enum is defined.

     * Used to report error messages.

     */

    public Locator getLocator() {

        return sourceLocator;

    }

    public QName getTypeName() {

        return typeName;

    }

    public NType getType() {

        return this;

    }

    /**

     * @deprecated

     *      why are you calling the method whose return value is known?

     */

    public boolean canBeReferencedByIDREF() {

        return false;

    }

    public boolean isElement() {

        return false;

    }

    public QName getElementName() {

        return null;

    }

    public Element<NType,NClass> asElement() {

        return null;

    }

    public NClass getClazz() {

        return this;

    }

    public XSComponent getSchemaComponent() {

        return source;

    }

    public JClass toType(Outline o, Aspect aspect) {

        return o.getEnum(this).clazz;

    }

    public boolean isAbstract() {

        return false;

    }

    public boolean isBoxedType() {

        return false;

    }

    public String fullName() {

        return parent.fullName()+'.'+shortName;

    }

    public boolean isPrimitive() {

        return false;

    }

    public boolean isSimpleType() {

        return true;

    }

    /**

     * The spec says the value field in the enum class will be generated

     * only under certain circumstances.

     *

     * @return

     *      true if the generated enum class should have the value field.

     */

    public boolean needsValueField() {

        for (CEnumConstant cec : members) {

            if(!cec.getName().equals(cec.getLexicalValue()))

                return true;

        }

        return false;

    }

    public JExpression createConstant(Outline outline, XmlString literal) {

        // correctly identifying which constant it maps to is hard, so

        // here I'm cheating

        JClass type = toType(outline,Aspect.EXPOSED);

        for (CEnumConstant mem : members) {

            if(mem.getLexicalValue().equals(literal.value))

                return type.staticRef(mem.getName());

        }

        return null;

    }

    @Deprecated

    public boolean isCollection() {

        return false;

    }

    @Deprecated

    public CAdapter getAdapterUse() {

        return null;

    }

    @Deprecated

    public CNonElement getInfo() {

        return this;

    }

    public ID idUse() {

        return ID.NONE;

    }

    public MimeType getExpectedMimeType() {

        return null;

    }

    public Collection<CEnumConstant> getConstants() {

        return members;

    }

    public NonElement<NType,NClass> getBaseType() {

        return base;

    }

    public CCustomizations getCustomizations() {

        return customizations;

    }

    public Locatable getUpstream() {

        throw new UnsupportedOperationException();

    }

    public Location getLocation() {

        throw new UnsupportedOperationException();

    }

}