001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.marshall.yaml;
018
019import static java.lang.annotation.ElementType.*;
020import static java.lang.annotation.RetentionPolicy.*;
021
022import java.lang.annotation.*;
023
024import org.apache.juneau.marshall.*;
025import org.apache.juneau.marshall.serializer.*;
026
027/**
028 * Annotation for specifying config properties defined in {@link YamlSerializer} and {@link YamlParser}.
029 *
030 * <p>
031 * Used primarily for specifying bean configuration properties on REST classes and methods.
032 */
033@Target({ TYPE, METHOD })
034@Retention(RUNTIME)
035@Inherited
036@ContextApply({ YamlConfigAnnotation.SerializerApply.class, YamlConfigAnnotation.ParserApply.class })
037public @interface YamlConfig {
038
039   /**
040    * Add <js>"_type"</js> properties when needed.
041    *
042    * <p>
043    * If <js>"true"</js>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
044    * through reflection.
045    *
046    * <p>
047    * When present, this value overrides the {@link org.apache.juneau.marshall.serializer.Serializer.Builder#addBeanTypes() Serializer.Builder#addBeanTypes()} setting and is
048    * provided to customize the behavior of specific serializers in a {@link SerializerSet}.
049    *
050    * <ul class='values'>
051    *    <li><js>"true"</js>
052    *    <li><js>"false"</js> (default)
053    * </ul>
054    *
055    * <h5 class='section'>Notes:</h5><ul>
056    *    <li class='note'>
057    *       Supports <a class="doclink" href="https://juneau.apache.org/docs/topics/DefaultVarResolver">VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
058    * </ul>
059    *
060    * <h5 class='section'>See Also:</h5><ul>
061    *    <li class='jm'>{@link YamlSerializer.Builder#addBeanTypesYaml()}
062    * </ul>
063    *
064    * @return The annotation value.
065    */
066   String addBeanTypes() default "";
067
068   /**
069    * Optional rank for this config.
070    *
071    * <p>
072    * Can be used to override default ordering and application of config annotations.
073    *
074    * @return The annotation value.
075    */
076   int rank() default 0;
077}