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;
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 * Indicates that the given type is capable of being serialized and deserialized
027 * by an object mapper.
028 *
029 * <p>Types with this annotation must be instantiable by the object mapper. By
030 * default, this includes objects with zero-argument constructors and records,
031 * but this may be extended using a customized
032 * {@link org.spongepowered.configurate.objectmapping.ObjectMapper.Factory}.</p>
033 *
034 * @since 4.0.0
035 */
036@Retention(RetentionPolicy.RUNTIME)
037@Target(ElementType.TYPE)
038@Documented
039public @interface ConfigSerializable {
040}