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.msgpack.annotation;
018
019import static java.lang.annotation.ElementType.*;
020import static java.lang.annotation.RetentionPolicy.*;
021
022import java.lang.annotation.*;
023
024import org.apache.juneau.annotation.*;
025import org.apache.juneau.msgpack.*;
026import org.apache.juneau.serializer.*;
027
028/**
029 * Annotation for specifying config properties defined in {@link MsgPackSerializer} and {@link MsgPackParser}.
030 *
031 * <p>
032 * Used primarily for specifying bean configuration properties on REST classes and methods.
033 *
034 * <h5 class='section'>See Also:</h5><ul>
035 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/MessagePackBasics">MessagePack Basics</a>
036 * </ul>
037 */
038@Target({TYPE,METHOD})
039@Retention(RUNTIME)
040@Inherited
041@ContextApply({MsgPackConfigAnnotation.SerializerApply.class,MsgPackConfigAnnotation.ParserApply.class})
042public @interface MsgPackConfig {
043
044   /**
045    * Optional rank for this config.
046    *
047    * <p>
048    * Can be used to override default ordering and application of config annotations.
049    *
050    * @return The annotation value.
051    */
052   int rank() default 0;
053
054   //-------------------------------------------------------------------------------------------------------------------
055   // MsgPackCommon
056   //-------------------------------------------------------------------------------------------------------------------
057
058   //-------------------------------------------------------------------------------------------------------------------
059   // MsgPackSerializer
060   //-------------------------------------------------------------------------------------------------------------------
061
062   /**
063    * Add <js>"_type"</js> properties when needed.
064    *
065    * <p>
066    * If <js>"true"</js>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
067    * through reflection.
068    *
069    * <p>
070    * When present, this value overrides the {@link org.apache.juneau.serializer.Serializer.Builder#addBeanTypes()} setting and is
071    * provided to customize the behavior of specific serializers in a {@link SerializerSet}.
072    *
073    * <ul class='values'>
074    *    <li><js>"true"</js>
075    *    <li><js>"false"</js> (default)
076    * </ul>
077    *
078    * <h5 class='section'>Notes:</h5><ul>
079    *    <li class='note'>
080    *       Supports <a class="doclink" href="https://juneau.apache.org/docs/topics/DefaultVarResolver">VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
081    * </ul>
082    *
083    * <h5 class='section'>See Also:</h5><ul>
084    *    <li class='jm'>{@link org.apache.juneau.msgpack.MsgPackSerializer.Builder#addBeanTypesMsgPack()}
085    * </ul>
086    *
087    * @return The annotation value.
088    */
089   String addBeanTypes() default "";
090}