src/share/jaxws_classes/com/sun/xml/internal/ws/api/model/ParameterBinding.java

Thu, 31 Aug 2017 15:18:52 +0800

author
aoqi
date
Thu, 31 Aug 2017 15:18:52 +0800
changeset 637
9c07ef4934dd
parent 368
0989ad8c0860
parent 0
373ffda63c9a
permissions
-rw-r--r--

merge

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 1997, 2012, 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.xml.internal.ws.api.model;
aoqi@0 27
aoqi@0 28 /**
aoqi@0 29 * Denotes the binding of a parameter.
aoqi@0 30 *
aoqi@0 31 * <p>
aoqi@0 32 * This is somewhat like an enumeration (but it is <b>NOT</b> an enumeration.)
aoqi@0 33 *
aoqi@0 34 * <p>
aoqi@0 35 * The possible values are
aoqi@0 36 * BODY, HEADER, UNBOUND, and ATTACHMENT. BODY, HEADER, and UNBOUND
aoqi@0 37 * has a singleton semantics, but there are multiple ATTACHMENT instances
aoqi@0 38 * as it carries additional MIME type parameter.
aoqi@0 39 *
aoqi@0 40 * <p>
aoqi@0 41 * So don't use '==' for testing the equality.
aoqi@0 42 */
aoqi@0 43 public final class ParameterBinding {
aoqi@0 44 /**
aoqi@0 45 * Singleton instance that represents 'BODY'
aoqi@0 46 */
aoqi@0 47 public static final ParameterBinding BODY = new ParameterBinding(Kind.BODY,null);
aoqi@0 48 /**
aoqi@0 49 * Singleton instance that represents 'HEADER'
aoqi@0 50 */
aoqi@0 51 public static final ParameterBinding HEADER = new ParameterBinding(Kind.HEADER,null);
aoqi@0 52 /**
aoqi@0 53 * Singleton instance that represents 'UNBOUND',
aoqi@0 54 * meaning the parameter doesn't have a representation in a SOAP message.
aoqi@0 55 */
aoqi@0 56 public static final ParameterBinding UNBOUND = new ParameterBinding(Kind.UNBOUND,null);
aoqi@0 57 /**
aoqi@0 58 * Creates an instance that represents the attachment
aoqi@0 59 * with a given MIME type.
aoqi@0 60 *
aoqi@0 61 * <p>
aoqi@0 62 * TODO: shall we consider givint the singleton semantics by using
aoqi@0 63 * a cache? It's more elegant to do so, but
aoqi@0 64 * no where in JAX-WS RI two {@link ParameterBinding}s are compared today,
aoqi@0 65 */
aoqi@0 66 public static ParameterBinding createAttachment(String mimeType) {
aoqi@0 67 return new ParameterBinding(Kind.ATTACHMENT,mimeType);
aoqi@0 68 }
aoqi@0 69
aoqi@0 70 /**
aoqi@0 71 * Represents 4 kinds of binding.
aoqi@0 72 */
aoqi@0 73 public static enum Kind {
aoqi@0 74 BODY, HEADER, UNBOUND, ATTACHMENT;
aoqi@0 75 }
aoqi@0 76
aoqi@0 77
aoqi@0 78 /**
aoqi@0 79 * Represents the kind of {@link ParameterBinding}.
aoqi@0 80 * Always non-null.
aoqi@0 81 */
aoqi@0 82 public final Kind kind;
aoqi@0 83
aoqi@0 84 /**
aoqi@0 85 * Only used with attachment binding.
aoqi@0 86 */
aoqi@0 87 private String mimeType;
aoqi@0 88
aoqi@0 89 private ParameterBinding(Kind kind,String mimeType) {
aoqi@0 90 this.kind = kind;
aoqi@0 91 this.mimeType = mimeType;
aoqi@0 92 }
aoqi@0 93
aoqi@0 94
aoqi@0 95
aoqi@0 96 public String toString() {
aoqi@0 97 return kind.toString();
aoqi@0 98 }
aoqi@0 99
aoqi@0 100 /**
aoqi@0 101 * Returns the MIME type associated with this binding.
aoqi@0 102 *
aoqi@0 103 * @throws IllegalStateException
aoqi@0 104 * if this binding doesn't represent an attachment.
aoqi@0 105 * IOW, if {@link #isAttachment()} returns false.
aoqi@0 106 * @return
aoqi@0 107 * Can be null, if the MIME type is not known.
aoqi@0 108 */
aoqi@0 109 public String getMimeType() {
aoqi@0 110 if(!isAttachment())
aoqi@0 111 throw new IllegalStateException();
aoqi@0 112 return mimeType;
aoqi@0 113 }
aoqi@0 114
aoqi@0 115 public boolean isBody(){
aoqi@0 116 return this==BODY;
aoqi@0 117 }
aoqi@0 118
aoqi@0 119 public boolean isHeader(){
aoqi@0 120 return this==HEADER;
aoqi@0 121 }
aoqi@0 122
aoqi@0 123 public boolean isUnbound(){
aoqi@0 124 return this==UNBOUND;
aoqi@0 125 }
aoqi@0 126
aoqi@0 127 public boolean isAttachment(){
aoqi@0 128 return kind==Kind.ATTACHMENT;
aoqi@0 129 }
aoqi@0 130 }

mercurial