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
020/**
021 * Property name/value pair used in the {@link RestResource#properties() @RestResource(properties)} annotation.
022 *
023 * <p>
024 * Any of the properties defined on any of the serializers or parsers can be defined.
025 *
026 * <p>
027 * Property values types that are not <code>Strings</code> will automatically be converted to the correct type
028 * (e.g. <code>Boolean</code>, etc...).
029 *
030 * <h5 class='section'>See Also:</h5>
031 * <ul>
032 *    <li class='link'>{@doc juneau-rest-server.Properties}
033 * </ul>
034 */
035@Documented
036@Target(ANNOTATION_TYPE)
037@Retention(RUNTIME)
038@Inherited
039public @interface Property {
040
041   /**
042    * Property name.
043    */
044   String name();
045
046   /**
047    * Property value.
048    */
049   String value();
050}