001/* 002 * Configurate 003 * Copyright (C) zml and Configurate contributors 004 * 005 * Licensed under the Apache License, Version 2.0 (the "License"); 006 * you may not use this file except in compliance with the License. 007 * 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 ninja.leaping.configurate.objectmapping; 018 019import java.lang.annotation.Documented; 020import java.lang.annotation.ElementType; 021import java.lang.annotation.Retention; 022import java.lang.annotation.RetentionPolicy; 023import java.lang.annotation.Target; 024 025/** 026 * Marks a field to be mapped by an {@link ObjectMapper}. 027 */ 028@Retention(RetentionPolicy.RUNTIME) 029@Target(ElementType.FIELD) 030@Documented 031public @interface Setting { 032 033 /** 034 * The path this setting is located at 035 * 036 * @return The path 037 */ 038 String value() default ""; 039 040 /** 041 * The default comment associated with this configuration node 042 * This will be applied to any comment-capable configuration loader 043 * 044 * @return The comment 045 */ 046 String comment() default ""; 047 048}