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.interfaces.meta;
018
019import java.lang.annotation.ElementType;
020import java.lang.annotation.Retention;
021import java.lang.annotation.RetentionPolicy;
022import java.lang.annotation.Target;
023
024/**
025 * This annotation allows you to read the config node as normal, but it only
026 * writes the node when the value is not the default value. This is to ensure
027 * that when a user manually adds the entry, it remains there (as long as it's
028 * not the default value.)
029 *
030 * <p>Without a default value the annotated node will be read, but will never
031 * be written even if the user explicitly added it to their config.</p>
032 *
033 * <b>Note that Hidden doesn't work with default method getters due to a
034 * limitation, and Hidden will function like it doesn't have a default
035 * value.</b>
036 *
037 * @since 4.2.0
038 */
039@Retention(RetentionPolicy.RUNTIME)
040@Target({ElementType.METHOD, ElementType.FIELD})
041public @interface Hidden {
042}