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.ini;
018
019import static java.lang.annotation.ElementType.*;
020import static java.lang.annotation.RetentionPolicy.*;
021
022import java.lang.annotation.*;
023
024/**
025 * Annotation for customizing INI 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@Documented
034@Target({ TYPE, FIELD, METHOD })
035@Retention(RUNTIME)
036@Inherited
037public @interface Ini {
038
039   /**
040    * Custom section name override.
041    *
042    * <p>
043    * For beans: overrides the property name as the section header.
044    *
045    * @return The annotation value.
046    */
047   String section() default "";
048
049   /**
050    * Comment text to emit before this property.
051    *
052    * @return The annotation value.
053    */
054   String comment() default "";
055
056   /**
057    * Force JSON5 encoding even for simple values.
058    *
059    * @return The annotation value.
060    */
061   boolean json5Encoding() default false;
062}