aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.internal.xjc.model;
aoqi@0: 
aoqi@0: import javax.activation.MimeType;
aoqi@0: 
aoqi@0: import com.sun.codemodel.internal.JExpression;
aoqi@0: import com.sun.tools.internal.xjc.model.nav.NType;
aoqi@0: import com.sun.tools.internal.xjc.outline.Outline;
aoqi@0: import com.sun.xml.internal.bind.v2.model.core.ID;
aoqi@0: import com.sun.xml.internal.xsom.XmlString;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Information about how another type is referenced.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * In practice it is often easier to use {@link CTypeInfo}
aoqi@0:  * instead of {@link NType}, so this interface defines {@link #getInfo()}.
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  * @see TypeUseImpl
aoqi@0:  */
aoqi@0: public interface TypeUse {
aoqi@0:     /**
aoqi@0:      * If the use can hold multiple values of the specified type.
aoqi@0:      */
aoqi@0:     boolean isCollection();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * If this type use is adapting the type, returns the adapter.
aoqi@0:      * Otherwise return null.
aoqi@0:      */
aoqi@0:     CAdapter getAdapterUse();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Individual item type.
aoqi@0:      */
aoqi@0:     CNonElement getInfo();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Whether the referenced type (individual item type in case of collection)
aoqi@0:      * is ID/IDREF.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * ID is a property of a relationship. When a bean Foo has an ID property
aoqi@0:      * called 'bar' whose type is String, Foo isn't an ID, String isn't an ID,
aoqi@0:      * but this relationship is an ID (in the sense that Foo uses this String
aoqi@0:      * as an ID.)
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * The same thing can be said with IDREF. When Foo refers to Bar by means of
aoqi@0:      * IDREF, neither Foo nor Bar is IDREF.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * That's why we have this method in {@link TypeUse}.
aoqi@0:      */
aoqi@0:     ID idUse();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * A {@link TypeUse} can have an associated MIME type.
aoqi@0:      */
aoqi@0:     MimeType getExpectedMimeType();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Creates a constant for the given lexical value.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * For example, to create a constant 1 for <tt>xs:int</tt>, you'd do:
aoqi@0:      * <pre>
aoqi@0:      * CBuiltinLeafInfo.INT.createConstant( codeModel, "1", null );
aoqi@0:      * </pre>
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * This method is invoked at the backend as a part of the code generation process.
aoqi@0:      *
aoqi@0:      * @throws IllegalStateException
aoqi@0:      *      if the type isn't bound to a text in XML.
aoqi@0:      *
aoqi@0:      * @return null
aoqi@0:      *      if the constant cannot be created for this {@link TypeUse}
aoqi@0:      *      (such as when it's a collection)
aoqi@0:      */
aoqi@0:     JExpression createConstant(Outline outline, XmlString lexical);
aoqi@0: }