com.alibaba.fastjson2.annotation

Annotation Type JSONType

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface JSONType

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	alphabetic Property that defines what to do regarding ordering of properties not explicitly included in annotation instance.
java.lang.Class<? extends JSONReader.AutoTypeBeforeHandler>	autoTypeBeforeHandler
java.lang.Class<?>	builder
JSONReader.Feature[]	deserializeFeatures Specify JSONReader.Features to use features when deserializing
java.lang.Class<?>	deserializer
boolean	disableReferenceDetect Reduce code branches during code generation to improve performance, If it is true, there will be no code related to reference detection.
java.lang.String	format
java.lang.String[]	ignores
java.lang.String[]	includes
java.lang.String	locale
PropertyNamingStrategy	naming
java.lang.String[]	orders Order in which properties of annotated object are to be serialized in.
java.lang.String	rootName Similar to javax.xml.bind.annotation.XmlRootElement, used to indicate name to use for root-level wrapping, if wrapping is enabled.
java.lang.String	schema
java.lang.Class<?>[]	seeAlso
java.lang.Class<?>	seeAlsoDefault
JSONWriter.Feature[]	serializeFeatures Specify JSONWriter.Features to use features when serializing output
java.lang.Class<? extends Filter>[]	serializeFilters
java.lang.Class<?>	serializer
boolean	skipTransient
java.lang.String	typeKey
java.lang.String	typeName
boolean	writeEnumAsJavaBean

Element Detail

builder

public abstract java.lang.Class<?> builder

Default:

void.class

typeKey

public abstract java.lang.String typeKey

Default:

""

typeName

public abstract java.lang.String typeName

Default:

""

seeAlso

public abstract java.lang.Class<?>[] seeAlso

Default:

{}

seeAlsoDefault

public abstract java.lang.Class<?> seeAlsoDefault

Since:

2.0.24

Default:

java.lang.Void.class

alphabetic

public abstract boolean alphabetic

Property that defines what to do regarding ordering of properties not explicitly included in annotation instance. If set to true, they will be alphabetically ordered (default setting); if false, order is undefined

Returns:

true if properties should be alphabetically ordered, false otherwise

Default:

true

deserializeFeatures

public abstract JSONReader.Feature[] deserializeFeatures

Specify JSONReader.Features to use features when deserializing

Default:

{}

serializeFeatures

public abstract JSONWriter.Feature[] serializeFeatures

Specify JSONWriter.Features to use features when serializing output

Default:

{}

naming

public abstract PropertyNamingStrategy naming

Default:

com.alibaba.fastjson2.PropertyNamingStrategy.NeverUseThisValueExceptDefaultValue

writeEnumAsJavaBean

public abstract boolean writeEnumAsJavaBean

Default:

false

ignores

public abstract java.lang.String[] ignores

Default:

{}

includes

public abstract java.lang.String[] includes

Default:

{}

orders

public abstract java.lang.String[] orders

Order in which properties of annotated object are to be serialized in.

Default:

{}

serializer

public abstract java.lang.Class<?> serializer

Default:

java.lang.Void.class

deserializer

public abstract java.lang.Class<?> deserializer

Default:

java.lang.Void.class

serializeFilters

public abstract java.lang.Class<? extends Filter>[] serializeFilters

Default:

{}

schema

public abstract java.lang.String schema

Default:

""

format

public abstract java.lang.String format

Since:

2.0.8

Default:

""

locale

public abstract java.lang.String locale

Since:

2.0.8

Default:

""

autoTypeBeforeHandler

public abstract java.lang.Class<? extends JSONReader.AutoTypeBeforeHandler> autoTypeBeforeHandler

Since:

2.0.25

Default:

com.alibaba.fastjson2.JSONReader.AutoTypeBeforeHandler.class

disableReferenceDetect

public abstract boolean disableReferenceDetect

Reduce code branches during code generation to improve performance, If it is true, there will be no code related to reference detection.

Since:

2.0.50

Default:

false

rootName

public abstract java.lang.String rootName

Similar to javax.xml.bind.annotation.XmlRootElement, used to indicate name to use for root-level wrapping, if wrapping is enabled. Annotation itself does not indicate that wrapping should be used; but if it is, the name used for serialization should be the name specified here, and deserializer will expect the name as well.

Since:

2.0.52

Default:

""

skipTransient

public abstract boolean skipTransient

Since:

2.0.58

Default:

true