1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/jaxws_classes/com/sun/tools/internal/xjc/model/TypeUse.java Wed Apr 27 01:27:09 2016 +0800
1.3 @@ -0,0 +1,107 @@
1.4 +/*
1.5 + * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package com.sun.tools.internal.xjc.model;
1.30 +
1.31 +import javax.activation.MimeType;
1.32 +
1.33 +import com.sun.codemodel.internal.JExpression;
1.34 +import com.sun.tools.internal.xjc.model.nav.NType;
1.35 +import com.sun.tools.internal.xjc.outline.Outline;
1.36 +import com.sun.xml.internal.bind.v2.model.core.ID;
1.37 +import com.sun.xml.internal.xsom.XmlString;
1.38 +
1.39 +/**
1.40 + * Information about how another type is referenced.
1.41 + *
1.42 + * <p>
1.43 + * In practice it is often easier to use {@link CTypeInfo}
1.44 + * instead of {@link NType}, so this interface defines {@link #getInfo()}.
1.45 + *
1.46 + * @author Kohsuke Kawaguchi
1.47 + * @see TypeUseImpl
1.48 + */
1.49 +public interface TypeUse {
1.50 + /**
1.51 + * If the use can hold multiple values of the specified type.
1.52 + */
1.53 + boolean isCollection();
1.54 +
1.55 + /**
1.56 + * If this type use is adapting the type, returns the adapter.
1.57 + * Otherwise return null.
1.58 + */
1.59 + CAdapter getAdapterUse();
1.60 +
1.61 + /**
1.62 + * Individual item type.
1.63 + */
1.64 + CNonElement getInfo();
1.65 +
1.66 + /**
1.67 + * Whether the referenced type (individual item type in case of collection)
1.68 + * is ID/IDREF.
1.69 + *
1.70 + * <p>
1.71 + * ID is a property of a relationship. When a bean Foo has an ID property
1.72 + * called 'bar' whose type is String, Foo isn't an ID, String isn't an ID,
1.73 + * but this relationship is an ID (in the sense that Foo uses this String
1.74 + * as an ID.)
1.75 + *
1.76 + * <p>
1.77 + * The same thing can be said with IDREF. When Foo refers to Bar by means of
1.78 + * IDREF, neither Foo nor Bar is IDREF.
1.79 + *
1.80 + * <p>
1.81 + * That's why we have this method in {@link TypeUse}.
1.82 + */
1.83 + ID idUse();
1.84 +
1.85 + /**
1.86 + * A {@link TypeUse} can have an associated MIME type.
1.87 + */
1.88 + MimeType getExpectedMimeType();
1.89 +
1.90 + /**
1.91 + * Creates a constant for the given lexical value.
1.92 + *
1.93 + * <p>
1.94 + * For example, to create a constant 1 for <tt>xs:int</tt>, you'd do:
1.95 + * <pre>
1.96 + * CBuiltinLeafInfo.INT.createConstant( codeModel, "1", null );
1.97 + * </pre>
1.98 + *
1.99 + * <p>
1.100 + * This method is invoked at the backend as a part of the code generation process.
1.101 + *
1.102 + * @throws IllegalStateException
1.103 + * if the type isn't bound to a text in XML.
1.104 + *
1.105 + * @return null
1.106 + * if the constant cannot be created for this {@link TypeUse}
1.107 + * (such as when it's a collection)
1.108 + */
1.109 + JExpression createConstant(Outline outline, XmlString lexical);
1.110 +}
