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.json;
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 JsonSerializer} and {@link JsonParser}.
029 *
030 * <p>
031 * Used primarily for specifying bean configuration properties on REST classes and methods.
032 *
033 * <h5 class='section'>See Also:</h5><ul>
034 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JsonSupport">JSON</a>
035 * </ul>
036 */
037@Target({ TYPE, METHOD })
038@Retention(RUNTIME)
039@Inherited
040@ContextApply({ JsonConfigAnnotation.SerializerApply.class, JsonConfigAnnotation.ParserApply.class })
041public @interface JsonConfig {
042
043   /**
044    * Add <js>"_type"</js> properties when needed.
045    *
046    * <p>
047    * If <js>"true"</js>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
048    * through reflection.
049    *
050    * <p>
051    * When present, this value overrides the {@link org.apache.juneau.marshall.serializer.Serializer.Builder#addBeanTypes() Serializer.Builder#addBeanTypes()} setting and is
052    * provided to customize the behavior of specific serializers in a {@link SerializerSet}.
053    *
054    * <ul class='values'>
055    *    <li><js>"true"</js>
056    *    <li><js>"false"</js> (default)
057    * </ul>
058    *
059    * <h5 class='section'>Notes:</h5><ul>
060    *    <li class='note'>
061    *       Supports <a class="doclink" href="https://juneau.apache.org/docs/topics/DefaultVarResolver">VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
062    * </ul>
063    *
064    * <h5 class='section'>See Also:</h5><ul>
065    *    <li class='jm'>{@link JsonSerializer.Builder#addBeanTypesJson()}
066    * </ul>
067    *
068    * @return The annotation value.
069    */
070   String addBeanTypes() default "";
071
072   /**
073    * Prefix solidus <js>'/'</js> characters with escapes.
074    *
075    * <p>
076    * If <js>"true"</js>, solidus (e.g. slash) characters should be escaped.
077    * The JSON specification allows for either format.
078    * <br>However, if you're embedding JSON in an HTML script tag, this setting prevents confusion when trying to serialize
079    * <xt>&lt;\/script&gt;</xt>.
080    *
081    * <ul class='values'>
082    *    <li><js>"true"</js>
083    *    <li><js>"false"</js> (default)
084    * </ul>
085    *
086    * <h5 class='section'>Notes:</h5><ul>
087    *    <li class='note'>
088    *       Supports <a class="doclink" href="https://juneau.apache.org/docs/topics/DefaultVarResolver">VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
089    * </ul>
090    *
091    * <h5 class='section'>See Also:</h5><ul>
092    *    <li class='jm'>{@link JsonSerializer.Builder#escapeSolidus()}
093    * </ul>
094    *
095    * @return The annotation value.
096    */
097   String escapeSolidus() default "";
098
099   /**
100    * Optional rank for this config.
101    *
102    * <p>
103    * Can be used to override default ordering and application of config annotations.
104    *
105    * @return The annotation value.
106    */
107   int rank() default 0;
108
109   /**
110    * Validate end.
111    *
112    * <p>
113    * If <js>"true"</js>, after parsing a POJO from the input, verifies that the remaining input in
114    * the stream consists of only comments or whitespace.
115    *
116    * <ul class='values'>
117    *    <li><js>"true"</js>
118    *    <li><js>"false"</js> (default)
119    * </ul>
120    *
121    * <h5 class='section'>Notes:</h5><ul>
122    *    <li class='note'>
123    *       Supports <a class="doclink" href="https://juneau.apache.org/docs/topics/DefaultVarResolver">VarResolver.DEFAULT</a> (e.g. <js>"$C{myConfigVar}"</js>).
124    * </ul>
125    *
126    * <h5 class='section'>See Also:</h5><ul>
127    *    <li class='jm'>{@link JsonParser.Builder#validateEnd()}
128    * </ul>
129    *
130    * @return The annotation value.
131    */
132   String validateEnd() default "";
133}