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.plaintext.annotation;
014
015import static java.lang.annotation.ElementType.*;
016import static java.lang.annotation.RetentionPolicy.*;
017
018import java.lang.annotation.*;
019
020import org.apache.juneau.annotation.*;
021import org.apache.juneau.plaintext.*;
022
023/**
024 * Annotation for specifying config properties defined in {@link PlainTextSerializer} and {@link PlainTextParser}.
025 *
026 * <p>
027 * Used primarily for specifying bean configuration properties on REST classes and methods.
028 */
029@Documented
030@Target({TYPE,METHOD})
031@Retention(RUNTIME)
032@Inherited
033@PropertyStoreApply(PlainTextConfigApply.class)
034public @interface PlainTextConfig {
035
036   /**
037    * Optional rank for this config.
038    *
039    * <p>
040    * Can be used to override default ordering and application of config annotations.
041    */
042   int rank() default 0;
043
044   //-------------------------------------------------------------------------------------------------------------------
045   // PlainTextCommon
046   //-------------------------------------------------------------------------------------------------------------------
047
048   /**
049    * Dynamically applies {@link PlainText @PlainText} annotations to specified classes/methods/fields.
050    *
051    * <p>
052    * Provides an alternate approach for applying annotations using {@link PlainText#on() @PlainText.on} to specify the names
053    * to apply the annotation to.
054    *
055    * <ul class='seealso'>
056    *    <li class='link'>{@doc juneau-marshall.DynamicallyAppliedAnnotations}
057    * </ul>
058    */
059   PlainText[] applyPlainText() default {};
060
061   //-------------------------------------------------------------------------------------------------------------------
062   // PlainTextSerializer
063   //-------------------------------------------------------------------------------------------------------------------
064
065   //-------------------------------------------------------------------------------------------------------------------
066   // PlainTextParser
067   //-------------------------------------------------------------------------------------------------------------------
068}