io.github.wycst.wast.json.annotations.JsonProperty Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wast Show documentation

Wast is a high-performance Java toolset library package that includes JSON, YAML, CSV, HttpClient, JDBC and EL engines

The newest version!

package io.github.wycst.wast.json.annotations;

import io.github.wycst.wast.common.beans.GregorianDate;

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

/**
 * @Author: wangy
 * @Description:
 */
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface JsonProperty {

    /**
     * 指定别名序列化或者反序列化名称
     *
     * @return
     */
    public String name() default "";

    /**
     * json序列化操作时，当前属性是否序列化
     *
     * @return
     */
    public boolean serialize() default true;

    /**
     * json解析时当前属性是否反序列化
     *
     * @return
     */
    public boolean deserialize() default true;

    /**
     * 数据转换时日期序列化格式或字符串反序列化为日期
     *
     * @return
     * @see GregorianDate#format(String)
     */
    public String pattern() default "";

    /**
     * 序列化为时间戳，如果为true优先级高于pattern
     */
    public boolean asTimestamp() default false;

    /**
     * 时区表达式
     * 默认情况下使用TimeZone的默认时区
     * 支持格式: +1, +1:00, -8, +8:00, +08:30等使用GMT
     *
     * @return
     * @see java.util.TimeZone#getTimeZone(String)
     */
    public String timezone() default "";

    /**
     *  如果属性声明的类型为接口或者抽象类，可以为属性指定缺省实现类(如果不是属性声明的子类会被忽略)；
     * 
 如果不是接口或抽象类，此配置忽略；
     * 
 支持Map/List等指定实现类
     *
     * @return
     */
    public Class impl() default Object.class;


    /**
     * 是否不固定类型，比如属性的声明类型为父类存在很多子类实现，实际的值类型不确定是哪个场景
     *
     * 
1.序列化会写入字段类型(@c)
     * 2.反序列化会第一时间读取类型（第一个字段@c）
     * 3.只针对pojo类型的字段生效
     * @return
     */
    public boolean unfixedType() default false;
}