com.sun.xml.ws.model.WrapperParameter Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 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
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or 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 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.model;
import com.sun.xml.ws.api.model.JavaMethod;
import com.sun.xml.ws.api.model.ParameterBinding;
import com.sun.xml.ws.spi.db.TypeInfo;
import com.sun.xml.ws.spi.db.WrapperComposite;
import javax.jws.WebParam.Mode;
import java.util.ArrayList;
import java.util.List;
/**
* {@link ParameterImpl} that represents a wrapper,
* which is a parameter that consists of multiple nested {@link ParameterImpl}s
* within, which together form a body part.
*
*
* Java method parameters represented by nested {@link ParameterImpl}s will be
* packed into a "wrapper bean" and it becomes the {@link ParameterImpl} for the
* body.
*
*
* This parameter is only used for the {@link ParameterBinding#BODY} binding.
* Other parameters that bind to other parts (such as headers or unbound)
* will show up directly under {@link JavaMethod}.
*
* @author Vivek Pandey
*/
public class WrapperParameter extends ParameterImpl {
protected final List wrapperChildren = new ArrayList();
// TODO: wrapper parameter doesn't use 'typeRef' --- it only uses tag name.
public WrapperParameter(JavaMethodImpl parent, TypeInfo typeRef, Mode mode, int index) {
super(parent, typeRef, mode, index);
//chen workaround for document-literal wrapper - new feature on eclipselink API requested
typeRef.properties().put(WrapperParameter.class.getName(), this);
}
/**
*
* @deprecated
* Why are you calling a method that always return true?
*/
@Override
public boolean isWrapperStyle() {
return true;
}
/**
* @return Returns the wrapperChildren.
*/
public List getWrapperChildren() {
return wrapperChildren;
}
/**
* Adds a new child parameter.
*
* @param wrapperChild
*/
public void addWrapperChild(ParameterImpl wrapperChild) {
wrapperChildren.add(wrapperChild);
wrapperChild.wrapper = this;
// must bind to body. see class javadoc
assert wrapperChild.getBinding()== ParameterBinding.BODY;
}
public void clear(){
wrapperChildren.clear();
}
@Override
void fillTypes(List types) {
super.fillTypes(types);
if(WrapperComposite.class.equals(getTypeInfo().type)) {
for (ParameterImpl p : wrapperChildren) p.fillTypes(types);
}
// if(getParent().getBinding().isRpcLit()) {
// // for rpc/lit, we need to individually marshal/unmarshal wrapped values,
// // so their TypeReference needs to be collected
//// assert getTypeReference().type==CompositeStructure.class;
// for (ParameterImpl p : wrapperChildren)
// p.fillTypes(types);
// }
}
}