aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.ws.model;
aoqi@0: 
aoqi@0: import com.sun.xml.internal.ws.api.model.JavaMethod;
aoqi@0: import com.sun.xml.internal.ws.api.model.ParameterBinding;
aoqi@0: import com.sun.xml.internal.ws.spi.db.TypeInfo;
aoqi@0: import com.sun.xml.internal.ws.spi.db.WrapperComposite;
aoqi@0: 
aoqi@0: import javax.jws.WebParam.Mode;
aoqi@0: import java.util.ArrayList;
aoqi@0: import java.util.List;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * {@link ParameterImpl} that represents a wrapper,
aoqi@0:  * which is a parameter that consists of multiple nested {@link ParameterImpl}s
aoqi@0:  * within, which together form a body part.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * Java method parameters represented by nested {@link ParameterImpl}s will be
aoqi@0:  * packed into a "wrapper bean" and it becomes the {@link ParameterImpl} for the
aoqi@0:  * body.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * This parameter is only used for the {@link ParameterBinding#BODY} binding.
aoqi@0:  * Other parameters that bind to other parts (such as headers or unbound)
aoqi@0:  * will show up directly under {@link JavaMethod}.
aoqi@0:  *
aoqi@0:  * @author Vivek Pandey
aoqi@0:  */
aoqi@0: public class WrapperParameter extends ParameterImpl {
aoqi@0:     protected final List<ParameterImpl> wrapperChildren = new ArrayList<ParameterImpl>();
aoqi@0: 
aoqi@0:     // TODO: wrapper parameter doesn't use 'typeRef' --- it only uses tag name.
aoqi@0:     public WrapperParameter(JavaMethodImpl parent, TypeInfo typeRef, Mode mode, int index) {
aoqi@0:         super(parent, typeRef, mode, index);
aoqi@0:                 //chen workaround for document-literal wrapper - new feature on eclipselink API requested
aoqi@0:         typeRef.properties().put(WrapperParameter.class.getName(), this);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      *
aoqi@0:      * @deprecated
aoqi@0:      *      Why are you calling a method that always return true?
aoqi@0:      */
aoqi@0:     @Override
aoqi@0:     public boolean isWrapperStyle() {
aoqi@0:         return true;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * @return Returns the wrapperChildren.
aoqi@0:      */
aoqi@0:     public List<ParameterImpl> getWrapperChildren() {
aoqi@0:         return wrapperChildren;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Adds a new child parameter.
aoqi@0:      *
aoqi@0:      * @param wrapperChild
aoqi@0:      */
aoqi@0:     public void addWrapperChild(ParameterImpl wrapperChild) {
aoqi@0:         wrapperChildren.add(wrapperChild);
aoqi@0:         wrapperChild.wrapper = this;
aoqi@0:         // must bind to body. see class javadoc
aoqi@0:         assert wrapperChild.getBinding()== ParameterBinding.BODY;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void clear(){
aoqi@0:         wrapperChildren.clear();
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     void fillTypes(List<TypeInfo> types) {
aoqi@0:         super.fillTypes(types);
aoqi@0:         if(WrapperComposite.class.equals(getTypeInfo().type)) {
aoqi@0:             for (ParameterImpl p : wrapperChildren) p.fillTypes(types);
aoqi@0:         }
aoqi@0: //        if(getParent().getBinding().isRpcLit()) {
aoqi@0: //            // for rpc/lit, we need to individually marshal/unmarshal wrapped values,
aoqi@0: //            // so their TypeReference needs to be collected
aoqi@0: ////            assert getTypeReference().type==CompositeStructure.class;
aoqi@0: //            for (ParameterImpl p : wrapperChildren)
aoqi@0: //                p.fillTypes(types);
aoqi@0: //        }
aoqi@0:     }
aoqi@0: }