001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package com.sun.tools.xjc.model;
038:
039: import javax.activation.MimeType;
040:
041: import com.sun.codemodel.JExpression;
042: import com.sun.tools.xjc.model.nav.NType;
043: import com.sun.tools.xjc.outline.Outline;
044: import com.sun.xml.bind.v2.model.core.ID;
045: import com.sun.xml.xsom.XmlString;
046:
047: /**
048: * Information about how another type is referenced.
049: *
050: * <p>
051: * In practice it is often easier to use {@link CTypeInfo}
052: * instead of {@link NType}, so this interface defines {@link #getInfo()}.
053: *
054: * @author Kohsuke Kawaguchi
055: * @see TypeUseImpl
056: */
057: public interface TypeUse {
058: /**
059: * If the use can hold multiple values of the specified type.
060: */
061: boolean isCollection();
062:
063: /**
064: * If this type use is adapting the type, returns the adapter.
065: * Otherwise return null.
066: */
067: CAdapter getAdapterUse();
068:
069: /**
070: * Individual item type.
071: */
072: CNonElement getInfo();
073:
074: /**
075: * Whether the referenced type (individual item type in case of collection)
076: * is ID/IDREF.
077: *
078: * <p>
079: * ID is a property of a relationship. When a bean Foo has an ID property
080: * called 'bar' whose type is String, Foo isn't an ID, String isn't an ID,
081: * but this relationship is an ID (in the sense that Foo uses this String
082: * as an ID.)
083: *
084: * <p>
085: * The same thing can be said with IDREF. When Foo refers to Bar by means of
086: * IDREF, neither Foo nor Bar is IDREF.
087: *
088: * <p>
089: * That's why we have this method in {@link TypeUse}.
090: */
091: ID idUse();
092:
093: /**
094: * A {@link TypeUse} can have an associated MIME type.
095: */
096: MimeType getExpectedMimeType();
097:
098: /**
099: * Creates a constant for the given lexical value.
100: *
101: * <p>
102: * For example, to create a constant 1 for <tt>xs:int</tt>, you'd do:
103: * <pre>
104: * CBuiltinLeafInfo.INT.createConstant( codeModel, "1", null );
105: * </pre>
106: *
107: * <p>
108: * This method is invoked at the backend as a part of the code generation process.
109: *
110: * @throws IllegalStateException
111: * if the type isn't bound to a text in XML.
112: *
113: * @return null
114: * if the constant cannot be created for this {@link TypeUse}
115: * (such as when it's a collection)
116: */
117: JExpression createConstant(Outline outline, XmlString lexical);
118: }
|