ohair@286: /*
alanb@368:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.ws.server.sei;
ohair@286: 
ohair@286: import com.sun.xml.internal.ws.model.ParameterImpl;
ohair@286: import com.sun.xml.internal.ws.api.model.Parameter;
ohair@286: 
ohair@286: import javax.jws.WebParam.Mode;
ohair@286: import javax.xml.ws.Holder;
ohair@286: 
ohair@286: /**
ohair@286:  * Gets a value from an object that represents a parameter passed
ohair@286:  * as a method argument.
ohair@286:  *
ohair@286:  * <p>
ohair@286:  * This abstraction hides the handling of {@link Holder}.
ohair@286:  *
ohair@286:  * <p>
ohair@286:  * {@link ValueGetter} is a stateless behavior encapsulation.
ohair@286:  *
ohair@286:  * @author Kohsuke Kawaguchi
ohair@286:  */
ohair@286: public enum ValueGetter {
ohair@286:     /**
ohair@286:      * {@link ValueGetter} that works for {@link Mode#IN}  parameter.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * Since it's the IN mode, the parameter is not a {@link Holder},
ohair@286:      * therefore the parameter itself is a value.
ohair@286:      */
ohair@286:     PLAIN() {
ohair@286:         public Object get(Object parameter) {
ohair@286:             return parameter;
ohair@286:         }
ohair@286:     },
ohair@286:     /**
ohair@286:      * Creates {@link ValueGetter} that works for {@link Holder},
ohair@286:      * which is  {@link Mode#INOUT} or  {@link Mode#OUT}.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * In those {@link Mode}s, the parameter is a {@link Holder},
ohair@286:      * so the value to be sent is obtained by getting the value of the holder.
ohair@286:      */
ohair@286:     HOLDER() {
ohair@286:         public Object get(Object parameter) {
ohair@286:             if(parameter==null)
ohair@286:                 // the user is allowed to pass in null where a Holder is expected.
ohair@286:                 return null;
ohair@286:             return ((Holder)parameter).value;
ohair@286:         }
ohair@286:     };
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the value to be sent, from a parameter given as a method argument.
ohair@286:      */
ohair@286:     public abstract Object get(Object parameter);
ohair@286: 
ohair@286:     /**
ohair@286:      * Returns a {@link ValueGetter} suitable for the given {@link Parameter}.
ohair@286:      */
ohair@286:     public static ValueGetter get(ParameterImpl p) {
ohair@286:         // return value is always PLAIN
ohair@286:         if(p.getMode() == Mode.IN || p.getIndex() == -1) {
ohair@286:             return PLAIN;
ohair@286:         } else {
ohair@286:             return HOLDER;
ohair@286:         }
ohair@286:     }
ohair@286: }