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
024import org.apache.juneau.marshall.*;
025
026/**
027 * Annotation for specifying config properties defined in {@link IniSerializer} and {@link IniParser}.
028 *
029 * <p>
030 * Used primarily for specifying bean configuration properties on REST classes and methods.
031 */
032@Target({ TYPE, METHOD })
033@Retention(RUNTIME)
034@Inherited
035@ContextApply({ IniConfigAnnotation.SerializerApply.class, IniConfigAnnotation.ParserApply.class })
036public @interface IniConfig {
037
038   /**
039    * Key-value separator character.
040    *
041    * <ul class='values'>
042    *    <li><js>"="</js> (default)
043    *    <li><js>":"</js>
044    * </ul>
045    *
046    * @return The annotation value.
047    */
048   String kvSeparator() default "";
049
050   /**
051    * Whether to add spaces around the separator.
052    *
053    * <ul class='values'>
054    *    <li><js>"true"</js> (default) — <c>key = value</c>
055    *    <li><js>"false"</js> — <c>key=value</c>
056    * </ul>
057    *
058    * @return The annotation value.
059    */
060   String spacedSeparator() default "";
061
062   /**
063    * Whether to emit property descriptions as <c>#</c> comments.
064    *
065    * <ul class='values'>
066    *    <li><js>"true"</js>
067    *    <li><js>"false"</js> (default)
068    * </ul>
069    *
070    * @return The annotation value.
071    */
072   String useComments() default "";
073
074   /**
075    * Optional rank for this config.
076    *
077    * @return The annotation value.
078    */
079   int rank() default 0;
080}