src/share/jaxws_classes/com/sun/tools/internal/xjc/model/TypeUse.java

Thu, 24 May 2018 16:44:14 +0800

author
aoqi
date
Thu, 24 May 2018 16:44:14 +0800
changeset 1288
f4ace6971570
parent 0
373ffda63c9a
permissions
-rw-r--r--

Merge

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 package com.sun.tools.internal.xjc.model;
aoqi@0 27
aoqi@0 28 import javax.activation.MimeType;
aoqi@0 29
aoqi@0 30 import com.sun.codemodel.internal.JExpression;
aoqi@0 31 import com.sun.tools.internal.xjc.model.nav.NType;
aoqi@0 32 import com.sun.tools.internal.xjc.outline.Outline;
aoqi@0 33 import com.sun.xml.internal.bind.v2.model.core.ID;
aoqi@0 34 import com.sun.xml.internal.xsom.XmlString;
aoqi@0 35
aoqi@0 36 /**
aoqi@0 37 * Information about how another type is referenced.
aoqi@0 38 *
aoqi@0 39 * <p>
aoqi@0 40 * In practice it is often easier to use {@link CTypeInfo}
aoqi@0 41 * instead of {@link NType}, so this interface defines {@link #getInfo()}.
aoqi@0 42 *
aoqi@0 43 * @author Kohsuke Kawaguchi
aoqi@0 44 * @see TypeUseImpl
aoqi@0 45 */
aoqi@0 46 public interface TypeUse {
aoqi@0 47 /**
aoqi@0 48 * If the use can hold multiple values of the specified type.
aoqi@0 49 */
aoqi@0 50 boolean isCollection();
aoqi@0 51
aoqi@0 52 /**
aoqi@0 53 * If this type use is adapting the type, returns the adapter.
aoqi@0 54 * Otherwise return null.
aoqi@0 55 */
aoqi@0 56 CAdapter getAdapterUse();
aoqi@0 57
aoqi@0 58 /**
aoqi@0 59 * Individual item type.
aoqi@0 60 */
aoqi@0 61 CNonElement getInfo();
aoqi@0 62
aoqi@0 63 /**
aoqi@0 64 * Whether the referenced type (individual item type in case of collection)
aoqi@0 65 * is ID/IDREF.
aoqi@0 66 *
aoqi@0 67 * <p>
aoqi@0 68 * ID is a property of a relationship. When a bean Foo has an ID property
aoqi@0 69 * called 'bar' whose type is String, Foo isn't an ID, String isn't an ID,
aoqi@0 70 * but this relationship is an ID (in the sense that Foo uses this String
aoqi@0 71 * as an ID.)
aoqi@0 72 *
aoqi@0 73 * <p>
aoqi@0 74 * The same thing can be said with IDREF. When Foo refers to Bar by means of
aoqi@0 75 * IDREF, neither Foo nor Bar is IDREF.
aoqi@0 76 *
aoqi@0 77 * <p>
aoqi@0 78 * That's why we have this method in {@link TypeUse}.
aoqi@0 79 */
aoqi@0 80 ID idUse();
aoqi@0 81
aoqi@0 82 /**
aoqi@0 83 * A {@link TypeUse} can have an associated MIME type.
aoqi@0 84 */
aoqi@0 85 MimeType getExpectedMimeType();
aoqi@0 86
aoqi@0 87 /**
aoqi@0 88 * Creates a constant for the given lexical value.
aoqi@0 89 *
aoqi@0 90 * <p>
aoqi@0 91 * For example, to create a constant 1 for <tt>xs:int</tt>, you'd do:
aoqi@0 92 * <pre>
aoqi@0 93 * CBuiltinLeafInfo.INT.createConstant( codeModel, "1", null );
aoqi@0 94 * </pre>
aoqi@0 95 *
aoqi@0 96 * <p>
aoqi@0 97 * This method is invoked at the backend as a part of the code generation process.
aoqi@0 98 *
aoqi@0 99 * @throws IllegalStateException
aoqi@0 100 * if the type isn't bound to a text in XML.
aoqi@0 101 *
aoqi@0 102 * @return null
aoqi@0 103 * if the constant cannot be created for this {@link TypeUse}
aoqi@0 104 * (such as when it's a collection)
aoqi@0 105 */
aoqi@0 106 JExpression createConstant(Outline outline, XmlString lexical);
aoqi@0 107 }

mercurial