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

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 637
9c07ef4934dd
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

ohair@286 1 /*
alanb@368 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package com.sun.xml.internal.ws.api.model;
ohair@286 27
ohair@286 28 /**
ohair@286 29 * Denotes the binding of a parameter.
ohair@286 30 *
ohair@286 31 * <p>
ohair@286 32 * This is somewhat like an enumeration (but it is <b>NOT</b> an enumeration.)
ohair@286 33 *
ohair@286 34 * <p>
ohair@286 35 * The possible values are
ohair@286 36 * BODY, HEADER, UNBOUND, and ATTACHMENT. BODY, HEADER, and UNBOUND
ohair@286 37 * has a singleton semantics, but there are multiple ATTACHMENT instances
ohair@286 38 * as it carries additional MIME type parameter.
ohair@286 39 *
ohair@286 40 * <p>
ohair@286 41 * So don't use '==' for testing the equality.
ohair@286 42 */
ohair@286 43 public final class ParameterBinding {
ohair@286 44 /**
ohair@286 45 * Singleton instance that represents 'BODY'
ohair@286 46 */
ohair@286 47 public static final ParameterBinding BODY = new ParameterBinding(Kind.BODY,null);
ohair@286 48 /**
ohair@286 49 * Singleton instance that represents 'HEADER'
ohair@286 50 */
ohair@286 51 public static final ParameterBinding HEADER = new ParameterBinding(Kind.HEADER,null);
ohair@286 52 /**
ohair@286 53 * Singleton instance that represents 'UNBOUND',
ohair@286 54 * meaning the parameter doesn't have a representation in a SOAP message.
ohair@286 55 */
ohair@286 56 public static final ParameterBinding UNBOUND = new ParameterBinding(Kind.UNBOUND,null);
ohair@286 57 /**
ohair@286 58 * Creates an instance that represents the attachment
ohair@286 59 * with a given MIME type.
ohair@286 60 *
ohair@286 61 * <p>
ohair@286 62 * TODO: shall we consider givint the singleton semantics by using
ohair@286 63 * a cache? It's more elegant to do so, but
ohair@286 64 * no where in JAX-WS RI two {@link ParameterBinding}s are compared today,
ohair@286 65 */
ohair@286 66 public static ParameterBinding createAttachment(String mimeType) {
ohair@286 67 return new ParameterBinding(Kind.ATTACHMENT,mimeType);
ohair@286 68 }
ohair@286 69
ohair@286 70 /**
ohair@286 71 * Represents 4 kinds of binding.
ohair@286 72 */
ohair@286 73 public static enum Kind {
ohair@286 74 BODY, HEADER, UNBOUND, ATTACHMENT;
ohair@286 75 }
ohair@286 76
ohair@286 77
ohair@286 78 /**
ohair@286 79 * Represents the kind of {@link ParameterBinding}.
ohair@286 80 * Always non-null.
ohair@286 81 */
ohair@286 82 public final Kind kind;
ohair@286 83
ohair@286 84 /**
ohair@286 85 * Only used with attachment binding.
ohair@286 86 */
ohair@286 87 private String mimeType;
ohair@286 88
ohair@286 89 private ParameterBinding(Kind kind,String mimeType) {
ohair@286 90 this.kind = kind;
ohair@286 91 this.mimeType = mimeType;
ohair@286 92 }
ohair@286 93
ohair@286 94
ohair@286 95
ohair@286 96 public String toString() {
ohair@286 97 return kind.toString();
ohair@286 98 }
ohair@286 99
ohair@286 100 /**
ohair@286 101 * Returns the MIME type associated with this binding.
ohair@286 102 *
ohair@286 103 * @throws IllegalStateException
ohair@286 104 * if this binding doesn't represent an attachment.
ohair@286 105 * IOW, if {@link #isAttachment()} returns false.
ohair@286 106 * @return
ohair@286 107 * Can be null, if the MIME type is not known.
ohair@286 108 */
ohair@286 109 public String getMimeType() {
ohair@286 110 if(!isAttachment())
ohair@286 111 throw new IllegalStateException();
ohair@286 112 return mimeType;
ohair@286 113 }
ohair@286 114
ohair@286 115 public boolean isBody(){
ohair@286 116 return this==BODY;
ohair@286 117 }
ohair@286 118
ohair@286 119 public boolean isHeader(){
ohair@286 120 return this==HEADER;
ohair@286 121 }
ohair@286 122
ohair@286 123 public boolean isUnbound(){
ohair@286 124 return this==UNBOUND;
ohair@286 125 }
ohair@286 126
ohair@286 127 public boolean isAttachment(){
ohair@286 128 return kind==Kind.ATTACHMENT;
ohair@286 129 }
ohair@286 130 }

mercurial