SoapBodyStyle.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * http://glassfish.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.xml.ws.api.databinding;

/**
 * The SoapBodyStyle represents the possible choices of the mapping styles
 * between the SOAP body of a wsdl:operation input/output messages and JAVA
 * method parameters and return/output values.
 * 
 * @author shih-chang.chen@oracle.com
 */
public enum SoapBodyStyle {

	/**
	 * Bare style mapping of a document style with literal use wsdl:operation
	 */
	DocumentBare,

	/**
	 * Wrapper style mapping of a document style with literal use wsdl:operation
	 */
	DocumentWrapper,

	/**
	 * The mapping style of a RPC style with literal use wsdl:operation
	 */
	RpcLiteral,

	/**
	 * The mapping style of a RPC style with encoded use wsdl:operation.
	 * 
	 * Note: this is not offically supported in JAX-WS.
	 */
	RpcEncoded,

	/**
	 * The mapping style is not specified.
	 */
	Unspecificed;

	public boolean isDocument() {
		return (this.equals(DocumentBare) || this.equals(DocumentWrapper));
	}

	public boolean isRpc() {
		return (this.equals(RpcLiteral) || this.equals(RpcEncoded));
	}

	public boolean isLiteral() {
		return (this.equals(RpcLiteral) || this.isDocument());
	}

	public boolean isBare() {
		return (this.equals(DocumentBare));
	}

	public boolean isDocumentWrapper() {
		return (this.equals(DocumentWrapper));
	}
}