Package com.alibaba.fastjson2.annotation

Annotation Type JSONType

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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	alphabetic	Property that defines what to do regarding ordering of properties not explicitly included in annotation instance.
Class<? extends JSONReader.AutoTypeBeforeHandler>	autoTypeBeforeHandler
Class<?>	builder
JSONReader.Feature[]	deserializeFeatures	Specify JSONReader.Features to use features when deserializing
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.
String	format
String[]	ignores
String[]	includes
String	locale
PropertyNamingStrategy	naming
String[]	orders	Order in which properties of annotated object are to be serialized in.
String	rootName	Similar to javax.xml.bind.annotation.XmlRootElement, used to indicate name to use for root-level wrapping, if wrapping is enabled.
String	schema
Class<?>[]	seeAlso
Class<?>	seeAlsoDefault
JSONWriter.Feature[]	serializeFeatures	Specify JSONWriter.Features to use features when serializing output
Class<? extends Filter>[]	serializeFilters
Class<?>	serializer
String	typeKey
String	typeName
boolean	writeEnumAsJavaBean

Element Detail

builder

Class<?> builder

Default:

void.class

typeKey

String typeKey

Default:

""

typeName

String typeName

Default:

""

seeAlso

Class<?>[] seeAlso

Default:

{}

seeAlsoDefault

Class<?> seeAlsoDefault

Since:

2.0.24

Default:

java.lang.Void.class

alphabetic

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:

Default:

true

deserializeFeatures

JSONReader.Feature[] deserializeFeatures

Specify JSONReader.Features to use features when deserializing

Default:

{}

serializeFeatures

JSONWriter.Feature[] serializeFeatures

Specify JSONWriter.Features to use features when serializing output

Default:

{}

naming

PropertyNamingStrategy naming

Default:

com.alibaba.fastjson2.PropertyNamingStrategy.NeverUseThisValueExceptDefaultValue

writeEnumAsJavaBean

boolean writeEnumAsJavaBean

Default:

false

ignores

String[] ignores

Default:

{}

includes

String[] includes

Default:

{}

orders

String[] orders

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

Default:

{}

serializer

Class<?> serializer

Default:

java.lang.Void.class

deserializer

Class<?> deserializer

Default:

java.lang.Void.class

serializeFilters

Class<? extends Filter>[] serializeFilters

Default:

{}

schema

String schema

Default:

""

format

String format

Since:

2.0.8

Default:

""

locale

String locale

Since:

2.0.8

Default:

""

autoTypeBeforeHandler

Class<? extends JSONReader.AutoTypeBeforeHandler> autoTypeBeforeHandler

Since:

2.0.25

Default:

com.alibaba.fastjson2.JSONReader.AutoTypeBeforeHandler.class

disableReferenceDetect

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

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:

""