com.ppiech.auto.value.jackson.annotation.JsonField Maven / Gradle / Ivy

Go to download
package com.ppiech.auto.value.jackson.annotation;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.CLASS;

/**
 * Declare that a variable should be parsed/serialized.
 * 
 * {@literal @}JsonField(name = "random_variable_name")
 * public String randomVariableName;
 * 
 */
@Target(FIELD)
@Retention(CLASS)
public @interface JsonField {

    /**
     * The name(s) of this field in JSON. Use an array if this could be represented by multiple names.
     * Note that using this field will override the enclosing JsonObject's fieldNamingPolicy.
     */
    String[] name() default {};

    /** The TypeConverter that will be used to parse/serialize this variable. */
    Class typeConverter() default void.class;

}