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.toml;
018
019import static java.lang.annotation.ElementType.*;
020import static java.lang.annotation.RetentionPolicy.*;
021
022import java.lang.annotation.*;
023
024/**
025 * Annotation for customizing TOML serialization and parsing behavior on classes, methods, and fields.
026 *
027 * <p>
028 * Can be used in the following locations:
029 * <ul>
030 *    <li>Marshalled classes/methods/fields.
031 * </ul>
032 *
033 * <p>
034 * Currently a marker annotation with no members; it establishes the per-format annotation surface
035 * (see {@link TomlApply @TomlApply}) so that members can be added without API changes.
036 *
037 * <h5 class='section'>Example:</h5>
038 * <p class='bjava'>
039 *    <ja>@Toml</ja>
040 *    <jk>public class</jk> MyBean {
041 *       <jk>public</jk> String <jf>name</jf>;
042 *    }
043 * </p>
044 *
045 * <h5 class='section'>See Also:</h5><ul>
046 *    <li class='link'><a class="doclink" href="https://toml.io/en/v1.0.0">TOML Specification</a>
047 * </ul>
048 */
049@Documented
050@Target({ TYPE, METHOD, FIELD })
051@Retention(RUNTIME)
052@Inherited
053public @interface Toml {
054}