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.rest.annotation;
014
015import static java.lang.annotation.ElementType.*;
016import static java.lang.annotation.RetentionPolicy.*;
017
018import java.lang.annotation.*;
019
020import org.apache.juneau.httppart.*;
021
022/**
023 * @deprecated Use {@link org.apache.juneau.http.annotation.Header}
024 */
025@Deprecated
026@Documented
027@Target(PARAMETER)
028@Retention(RUNTIME)
029@Inherited
030public @interface Header {
031
032   /**
033    * The default value for this header if it's not present in the request.
034    */
035   String def() default "";
036
037   /**
038    * HTTP header name.
039    */
040   String name() default "";
041
042   /**
043    * Specifies the {@link HttpPartParser} class used for parsing values from strings.
044    *
045    * <p>
046    * The default value for this parser is inherited from the servlet/method which defaults to {@link UonPartParser}.
047    * <br>You can use {@link SimplePartParser} to parse POJOs that are directly convertible from <code>Strings</code>.
048    */
049   Class<? extends HttpPartParser> parser() default HttpPartParser.Null.class;
050
051   /**
052    * A synonym for {@link #name()}.
053    *
054    * <p>
055    * Allows you to use shortened notation if you're only specifying the name.
056    */
057   String value() default "";
058}