Module com.sun.xml.ws
Package com.sun.xml.ws.api.model

Class ParameterBinding

java.lang.Object
com.sun.xml.ws.api.model.ParameterBinding
public final class ParameterBinding extends Object
Denotes the binding of a parameter.

This is somewhat like an enumeration (but it is NOT an enumeration.)

The possible values are BODY, HEADER, UNBOUND, and ATTACHMENT. BODY, HEADER, and UNBOUND has a singleton semantics, but there are multiple ATTACHMENT instances as it carries additional MIME type parameter.

So don't use '==' for testing the equality.

  • Field Details

    • BODY

      public static final ParameterBinding BODY
      Singleton instance that represents 'BODY'

    • UNBOUND

      public static final ParameterBinding UNBOUND
      Singleton instance that represents 'UNBOUND', meaning the parameter doesn't have a representation in a SOAP message.

    • kind

      public final ParameterBinding.Kind kind
      Represents the kind of ParameterBinding. Always non-null.

  • Method Details

    • createAttachment

      public static ParameterBinding createAttachment(String mimeType)
      Creates an instance that represents the attachment with a given MIME type.

      TODO: shall we consider givint the singleton semantics by using a cache? It's more elegant to do so, but no where in JAX-WS RI two ParameterBindings are compared today,

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getMimeType

      public String getMimeType()
      Returns the MIME type associated with this binding.
      Returns:
      Can be null, if the MIME type is not known.
      Throws:
      IllegalStateException - if this binding doesn't represent an attachment. IOW, if isAttachment() returns false.

    • isBody

      public boolean isBody()

    • isHeader

      public boolean isHeader()

    • isUnbound

      public boolean isUnbound()

    • isAttachment

      public boolean isAttachment()