001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.remoteable;
014
015import static java.lang.annotation.ElementType.*;
016import static java.lang.annotation.RetentionPolicy.*;
017
018import java.lang.annotation.*;
019
020import org.apache.juneau.httppart.*;
021import org.apache.juneau.urlencoding.*;
022
023/**
024 * Identical to {@link Query @Query} except skips values if they're null/blank.
025 * 
026 * <h5 class='section'>See Also:</h5>
027 * <ul class='doctree'>
028 *    <li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-rest-client.3rdPartyProxies'>Overview &gt; juneau-rest-client &gt; Interface Proxies Against 3rd-party REST Interfaces</a>
029 * </ul>
030 */
031@Documented
032@Target({PARAMETER,FIELD,METHOD})
033@Retention(RUNTIME)
034@Inherited
035public @interface QueryIfNE {
036
037   /**
038    * The query parameter name.
039    * 
040    * @see Query#name()
041    */
042   String name() default "";
043
044   /**
045    * A synonym for {@link #name()}.
046    * 
047    * @see Query#value()
048    */
049   String value() default "";
050
051   /**
052    * Specifies the {@link HttpPartSerializer} class used for serializing values to strings.
053    * 
054    * <p>
055    * The default value defaults to the using the part serializer defined on the {@link RequestBean @RequestBean} annotation,
056    * then on the client which by default is {@link UrlEncodingSerializer}.
057    * 
058    * <p>
059    * This annotation is provided to allow values to be custom serialized.
060    */
061   Class<? extends HttpPartSerializer> serializer() default HttpPartSerializer.Null.class;
062}