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 org.spongepowered.configurate.objectmapping.meta; 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 targeted by the object mapper. 027 * 028 * <p>Optionally, a path override can be provided.</p> 029 * 030 * <p>This annotation is not required on fields unless the 031 * {@link NodeResolver#onlyWithSetting()} resolver filter has been applied to 032 * the loading object mapper.</p> 033 * 034 * @since 4.0.0 035 */ 036@Documented 037@Retention(RetentionPolicy.RUNTIME) 038@Target(ElementType.FIELD) 039public @interface Setting { 040 041 /** 042 * The path this setting is located at. 043 * 044 * @return the path 045 * @since 4.0.0 046 */ 047 String value() default ""; 048 049 /** 050 * Whether a field should use its containing node for its value. 051 * 052 * @return whether this field should source its data from the node of 053 * its container 054 * @since 4.0.0 055 */ 056 boolean nodeFromParent() default false; 057 058}