JSONWriter.Context

java.lang.Object
- com.alibaba.fastjson2.JSONWriter.Context

Enclosing class:

JSONWriter
```
public static final class JSONWriter.Context
extends java.lang.Object
```
Context holds the configuration and state information for JSON writing operations. It controls various aspects of the serialization process including formatting, features, providers, filters, and other settings that affect how Java objects are converted to JSON format.
The Context class is responsible for:
- Managing writer features that control serialization behavior
- Handling date/time formatting and timezone settings
- Managing filters for customizing serialization output
- Storing serializer configuration such as max nesting level
- Providing object writer providers for type-specific serialization
Context instances can be created in several ways:
```
 // Using default configuration
 JSONWriter.Context context = new JSONWriter.Context();

 // With specific features enabled
 JSONWriter.Context context = new JSONWriter.Context(
     JSONWriter.Feature.PrettyFormat,
     JSONWriter.Feature.WriteMapNullValue
 );

 // With custom date format
 JSONWriter.Context context = new JSONWriter.Context("yyyy-MM-dd HH:mm:ss");

 // With custom provider and features
 ObjectWriterProvider provider = JSONFactory.getDefaultObjectWriterProvider();
 JSONWriter.Context context = new JSONWriter.Context(provider,
     JSONWriter.Feature.PrettyFormat
 );
 
```
Once created, a Context can be configured further:
```
 context.setZoneId(ZoneId.of("UTC"));
 context.setLocale(Locale.US);
 context.setMaxLevel(1000);
 context.setDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSXXX");
 
```
Context instances are typically used when creating JSONWriter instances:
```
 JSONWriter.Context context = new JSONWriter.Context();
 context.config(JSONWriter.Feature.PrettyFormat);

 try (JSONWriter writer = JSONWriter.of(context)) {
     writer.writeAny(object);
     String json = writer.toString();
 }
 
```
Note that Context instances are not thread-safe and should not be shared between multiple concurrent writing operations. Each JSONWriter should have its own Context instance or use the default context provided by factory methods.
Since:

2.0.0

See Also:

JSONWriter, JSONWriter.Feature, ObjectWriterProvider

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) AfterFilter`	`afterFilter`
`(package private) BeforeFilter`	`beforeFilter`
`(package private) ContextNameFilter`	`contextNameFilter`
`(package private) ContextValueFilter`	`contextValueFilter`
`(package private) java.lang.String`	`dateFormat`
`(package private) boolean`	`dateFormatISO8601`
`(package private) boolean`	`dateFormatMillis`
`(package private) java.time.format.DateTimeFormatter`	`dateFormatter`
`(package private) boolean`	`dateFormatUnixTime`
`(package private) static java.time.ZoneId`	`DEFAULT_ZONE_ID`
`(package private) long`	`features`
`(package private) boolean`	`formatHasDay`
`(package private) boolean`	`formatHasHour`
`(package private) boolean`	`formatyyyyMMddhhmmss19`
`(package private) boolean`	`hasFilter`
`(package private) LabelFilter`	`labelFilter`
`(package private) java.util.Locale`	`locale`
`(package private) int`	`maxLevel`
`(package private) NameFilter`	`nameFilter`
`(package private) PropertyFilter`	`propertyFilter`
`(package private) PropertyPreFilter`	`propertyPreFilter`
`ObjectWriterProvider`	`provider`
`(package private) ValueFilter`	`valueFilter`
`(package private) java.time.ZoneId`	`zoneId`

Constructor Summary

Constructors
Constructor and Description
`Context(JSONWriter.Feature... features)` Creates a new Context with the specified features.
`Context(ObjectWriterProvider provider)` Creates a new Context with the specified object writer provider.
`Context(ObjectWriterProvider provider, JSONWriter.Feature... features)` Creates a new Context with the specified object writer provider and features.
`Context(java.lang.String format, JSONWriter.Feature... features)` Creates a new Context with the specified date format and features.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`config(JSONWriter.Feature... features)` Configures features for this context.
`void`	`config(JSONWriter.Feature feature, boolean state)` Configures a specific feature for this context.
`void`	`configFilter(Filter... filters)` Configures filters for this context.
`AfterFilter`	`getAfterFilter()` Gets the after filter for this context.
`BeforeFilter`	`getBeforeFilter()` Gets the before filter for this context.
`ContextNameFilter`	`getContextNameFilter()` Gets the context name filter for this context.
`ContextValueFilter`	`getContextValueFilter()` Gets the context value filter for this context.
`java.lang.String`	`getDateFormat()` Gets the date format pattern for this context.
`java.time.format.DateTimeFormatter`	`getDateFormatter()` Gets the date formatter for this context.
`long`	`getFeatures()` Gets the features bitmask for this context.
`LabelFilter`	`getLabelFilter()` Gets the label filter for this context.
`int`	`getMaxLevel()` Gets the maximum nesting level allowed for this context.
`NameFilter`	`getNameFilter()` Gets the name filter for this context.
`<T> ObjectWriter<T>`	`getObjectWriter(java.lang.Class<T> objectType)` Gets the ObjectWriter for the specified object type.
`<T> ObjectWriter<T>`	`getObjectWriter(java.lang.reflect.Type objectType, java.lang.Class<T> objectClass)` Gets the ObjectWriter for the specified object type and class.
`PropertyFilter`	`getPropertyFilter()` Gets the property filter for this context.
`PropertyPreFilter`	`getPropertyPreFilter()` Gets the property pre-filter for this context.
`ObjectWriterProvider`	`getProvider()` Gets the ObjectWriterProvider used by this context.
`ValueFilter`	`getValueFilter()` Gets the value filter for this context.
`java.time.ZoneId`	`getZoneId()` Gets the ZoneId used by this context.
`boolean`	`isDateFormatHasDay()` Checks if the date format includes day information.
`boolean`	`isDateFormatHasHour()` Checks if the date format includes hour information.
`boolean`	`isDateFormatISO8601()` Checks if the date format is configured to use ISO8601 format.
`boolean`	`isDateFormatMillis()` Checks if the date format is configured to use milliseconds.
`boolean`	`isDateFormatUnixTime()` Checks if the date format is configured to use Unix time.
`boolean`	`isEnabled(JSONWriter.Feature feature)` Checks if the specified feature is enabled in this context.
`boolean`	`isEnabled(long feature)` Checks if the specified feature mask is enabled in this context.
`boolean`	`isFormatyyyyMMddhhmmss19()` Checks if the date format is configured to use yyyy-MM-dd HH:mm:ss format (19 characters).
`void`	`setAfterFilter(AfterFilter afterFilter)` Sets the after filter for this context.
`void`	`setBeforeFilter(BeforeFilter beforeFilter)` Sets the before filter for this context.
`void`	`setContextNameFilter(ContextNameFilter contextNameFilter)` Sets the context name filter for this context.
`void`	`setContextValueFilter(ContextValueFilter contextValueFilter)` Sets the context value filter for this context.
`void`	`setDateFormat(java.lang.String dateFormat)` Sets the date format pattern for this context.
`void`	`setFeatures(long features)` Sets the features bitmask for this context.
`void`	`setLabelFilter(LabelFilter labelFilter)` Sets the label filter for this context.
`void`	`setMaxLevel(int maxLevel)` Sets the maximum nesting level allowed for this context.
`void`	`setNameFilter(NameFilter nameFilter)` Sets the name filter for this context.
`void`	`setPropertyFilter(PropertyFilter propertyFilter)` Sets the property filter for this context.
`void`	`setPropertyPreFilter(PropertyPreFilter propertyPreFilter)` Sets the property pre-filter for this context.
`void`	`setValueFilter(ValueFilter valueFilter)` Sets the value filter for this context.
`void`	`setZoneId(java.time.ZoneId zoneId)` Sets the ZoneId for this context.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_ZONE_ID
```
static final java.time.ZoneId DEFAULT_ZONE_ID
```
  - provider
```
public final ObjectWriterProvider provider
```
  - dateFormatter
```
java.time.format.DateTimeFormatter dateFormatter
```
  - dateFormat
```
java.lang.String dateFormat
```
  - locale
```
java.util.Locale locale
```
  - dateFormatMillis
```
boolean dateFormatMillis
```
  - dateFormatISO8601
```
boolean dateFormatISO8601
```
  - dateFormatUnixTime
```
boolean dateFormatUnixTime
```
  - formatyyyyMMddhhmmss19
```
boolean formatyyyyMMddhhmmss19
```
  - formatHasDay
```
boolean formatHasDay
```
  - formatHasHour
```
boolean formatHasHour
```
  - features
```
long features
```
  - zoneId
```
java.time.ZoneId zoneId
```
  - maxLevel
```
int maxLevel
```
  - hasFilter
```
boolean hasFilter
```
  - propertyPreFilter
```
PropertyPreFilter propertyPreFilter
```
  - propertyFilter
```
PropertyFilter propertyFilter
```
  - nameFilter
```
NameFilter nameFilter
```
  - valueFilter
```
ValueFilter valueFilter
```
  - beforeFilter
```
BeforeFilter beforeFilter
```
  - afterFilter
```
AfterFilter afterFilter
```
  - labelFilter
```
LabelFilter labelFilter
```
  - contextValueFilter
```
ContextValueFilter contextValueFilter
```
  - contextNameFilter
```
ContextNameFilter contextNameFilter
```
- Constructor Detail
  - Context
```
public Context(ObjectWriterProvider provider)
```
    Creates a new Context with the specified object writer provider.
    
    Parameters:
    
    provider - the object writer provider to use
    
    Throws:
    
    java.lang.IllegalArgumentException - if provider is null
  - Context
```
public Context(JSONWriter.Feature... features)
```
    Creates a new Context with the specified features.
    
    Parameters:
    
    features - the features to enable
  - Context
```
public Context(java.lang.String format,
               JSONWriter.Feature... features)
```
    Creates a new Context with the specified date format and features.
    
    Parameters:
    
    format - the date format pattern to use
    
    features - the features to enable
  - Context
```
public Context(ObjectWriterProvider provider,
               JSONWriter.Feature... features)
```
    Creates a new Context with the specified object writer provider and features.
    
    Parameters:
    
    provider - the object writer provider to use
    
    features - the features to enable
    
    Throws:
    
    java.lang.IllegalArgumentException - if provider is null
- Method Detail
  - getFeatures
```
public long getFeatures()
```
    Gets the features bitmask for this context.
    
    Returns:
    
    the features bitmask
  - setFeatures
```
public void setFeatures(long features)
```
    Sets the features bitmask for this context.
    
    Parameters:
    
    features - the features bitmask to set
    
    Since:
    
    2.0.51
  - isEnabled
```
public boolean isEnabled(JSONWriter.Feature feature)
```
    Checks if the specified feature is enabled in this context.
    
    Parameters:
    
    feature - the feature to check
    
    Returns:
    
    true if the feature is enabled, false otherwise
  - isEnabled
```
public boolean isEnabled(long feature)
```
    Checks if the specified feature mask is enabled in this context.
    
    Parameters:
    
    feature - the feature mask to check
    
    Returns:
    
    true if the feature is enabled, false otherwise
  - config
```
public void config(JSONWriter.Feature... features)
```
    Configures features for this context.
    
    Parameters:
    
    features - the features to enable
  - config
```
public void config(JSONWriter.Feature feature,
                   boolean state)
```
    Configures a specific feature for this context.
    
    Parameters:
    
    feature - the feature to configure
    
    state - true to enable the feature, false to disable it
  - configFilter
```
public void configFilter(Filter... filters)
```
    Configures filters for this context.
    
    Parameters:
    
    filters - the filters to configure
  - getObjectWriter
```
public <T> ObjectWriter<T> getObjectWriter(java.lang.Class<T> objectType)
```
    Gets the ObjectWriter for the specified object type. This method retrieves an ObjectWriter instance that can serialize objects of the specified type.
    
    Type Parameters:
    
    T - the type of objects to be serialized
    
    Parameters:
    
    objectType - the class of objects to be serialized
    
    Returns:
    
    the ObjectWriter for the specified type
  - getObjectWriter
```
public <T> ObjectWriter<T> getObjectWriter(java.lang.reflect.Type objectType,
                                           java.lang.Class<T> objectClass)
```
    Gets the ObjectWriter for the specified object type and class. This method retrieves an ObjectWriter instance that can serialize objects of the specified type and class.
    
    Type Parameters:
    
    T - the type of objects to be serialized
    
    Parameters:
    
    objectType - the type of objects to be serialized
    
    objectClass - the class of objects to be serialized
    
    Returns:
    
    the ObjectWriter for the specified type and class
  - getProvider
```
public ObjectWriterProvider getProvider()
```
    Gets the ObjectWriterProvider used by this context.
    
    Returns:
    
    the ObjectWriterProvider
  - getZoneId
```
public java.time.ZoneId getZoneId()
```
    Gets the ZoneId used by this context. If no ZoneId has been set, the system default ZoneId will be returned.
    
    Returns:
    
    the ZoneId
  - setZoneId
```
public void setZoneId(java.time.ZoneId zoneId)
```
    Sets the ZoneId for this context.
    
    Parameters:
    
    zoneId - the ZoneId to set
  - getDateFormat
```
public java.lang.String getDateFormat()
```
    Gets the date format pattern for this context.
    
    Returns:
    
    the date format pattern, or null if not set
  - isDateFormatMillis
```
public boolean isDateFormatMillis()
```
    Checks if the date format is configured to use milliseconds.
    
    Returns:
    
    true if milliseconds format is enabled, false otherwise
  - isDateFormatUnixTime
```
public boolean isDateFormatUnixTime()
```
    Checks if the date format is configured to use Unix time.
    
    Returns:
    
    true if Unix time format is enabled, false otherwise
  - isDateFormatISO8601
```
public boolean isDateFormatISO8601()
```
    Checks if the date format is configured to use ISO8601 format.
    
    Returns:
    
    true if ISO8601 format is enabled, false otherwise
  - isDateFormatHasDay
```
public boolean isDateFormatHasDay()
```
    Checks if the date format includes day information.
    
    Returns:
    
    true if day information is included, false otherwise
  - isDateFormatHasHour
```
public boolean isDateFormatHasHour()
```
    Checks if the date format includes hour information.
    
    Returns:
    
    true if hour information is included, false otherwise
  - isFormatyyyyMMddhhmmss19
```
public boolean isFormatyyyyMMddhhmmss19()
```
    Checks if the date format is configured to use yyyy-MM-dd HH:mm:ss format (19 characters).
    
    Returns:
    
    true if this format is enabled, false otherwise
  - getDateFormatter
```
public java.time.format.DateTimeFormatter getDateFormatter()
```
    Gets the date formatter for this context.
    
    Returns:
    
    the date formatter, or null if not set
  - setDateFormat
```
public void setDateFormat(java.lang.String dateFormat)
```
    Sets the date format pattern for this context.
    
    Parameters:
    
    dateFormat - the date format pattern to set
  - getPropertyPreFilter
```
public PropertyPreFilter getPropertyPreFilter()
```
    Gets the property pre-filter for this context.
    
    Returns:
    
    the property pre-filter, or null if not set
  - setPropertyPreFilter
```
public void setPropertyPreFilter(PropertyPreFilter propertyPreFilter)
```
    Sets the property pre-filter for this context.
    
    Parameters:
    
    propertyPreFilter - the property pre-filter to set
  - getNameFilter
```
public NameFilter getNameFilter()
```
    Gets the name filter for this context.
    
    Returns:
    
    the name filter, or null if not set
  - setNameFilter
```
public void setNameFilter(NameFilter nameFilter)
```
    Sets the name filter for this context.
    
    Parameters:
    
    nameFilter - the name filter to set
  - getValueFilter
```
public ValueFilter getValueFilter()
```
    Gets the value filter for this context.
    
    Returns:
    
    the value filter, or null if not set
  - setValueFilter
```
public void setValueFilter(ValueFilter valueFilter)
```
    Sets the value filter for this context.
    
    Parameters:
    
    valueFilter - the value filter to set
  - getContextValueFilter
```
public ContextValueFilter getContextValueFilter()
```
    Gets the context value filter for this context.
    
    Returns:
    
    the context value filter, or null if not set
  - setContextValueFilter
```
public void setContextValueFilter(ContextValueFilter contextValueFilter)
```
    Sets the context value filter for this context.
    
    Parameters:
    
    contextValueFilter - the context value filter to set
  - getContextNameFilter
```
public ContextNameFilter getContextNameFilter()
```
    Gets the context name filter for this context.
    
    Returns:
    
    the context name filter, or null if not set
  - setContextNameFilter
```
public void setContextNameFilter(ContextNameFilter contextNameFilter)
```
    Sets the context name filter for this context.
    
    Parameters:
    
    contextNameFilter - the context name filter to set
  - getPropertyFilter
```
public PropertyFilter getPropertyFilter()
```
    Gets the property filter for this context.
    
    Returns:
    
    the property filter, or null if not set
  - setPropertyFilter
```
public void setPropertyFilter(PropertyFilter propertyFilter)
```
    Sets the property filter for this context.
    
    Parameters:
    
    propertyFilter - the property filter to set
  - getAfterFilter
```
public AfterFilter getAfterFilter()
```
    Gets the after filter for this context.
    
    Returns:
    
    the after filter, or null if not set
  - setAfterFilter
```
public void setAfterFilter(AfterFilter afterFilter)
```
    Sets the after filter for this context.
    
    Parameters:
    
    afterFilter - the after filter to set
  - getBeforeFilter
```
public BeforeFilter getBeforeFilter()
```
    Gets the before filter for this context.
    
    Returns:
    
    the before filter, or null if not set
  - setBeforeFilter
```
public void setBeforeFilter(BeforeFilter beforeFilter)
```
    Sets the before filter for this context.
    
    Parameters:
    
    beforeFilter - the before filter to set
  - getLabelFilter
```
public LabelFilter getLabelFilter()
```
    Gets the label filter for this context.
    
    Returns:
    
    the label filter, or null if not set
  - setLabelFilter
```
public void setLabelFilter(LabelFilter labelFilter)
```
    Sets the label filter for this context.
    
    Parameters:
    
    labelFilter - the label filter to set
  - getMaxLevel
```
public int getMaxLevel()
```
    Gets the maximum nesting level allowed for this context.
    
    Returns:
    
    the maximum nesting level
  - setMaxLevel
```
public void setMaxLevel(int maxLevel)
```
    Sets the maximum nesting level allowed for this context.
    
    Parameters:
    
    maxLevel - the maximum nesting level to set

Class JSONWriter.Context

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ZONE_ID

provider

dateFormatter

dateFormat

locale

dateFormatMillis

dateFormatISO8601

dateFormatUnixTime

formatyyyyMMddhhmmss19

formatHasDay

formatHasHour

features

zoneId

maxLevel

hasFilter

propertyPreFilter

propertyFilter

nameFilter

valueFilter

beforeFilter

afterFilter

labelFilter

contextValueFilter

contextNameFilter

Constructor Detail

Context

Context

Context

Context

Method Detail

getFeatures

setFeatures

isEnabled

isEnabled

config

config

configFilter

getObjectWriter

getObjectWriter

getProvider

getZoneId

setZoneId

getDateFormat

isDateFormatMillis

isDateFormatUnixTime

isDateFormatISO8601

isDateFormatHasDay

isDateFormatHasHour

isFormatyyyyMMddhhmmss19

getDateFormatter

setDateFormat

getPropertyPreFilter

setPropertyPreFilter

getNameFilter

setNameFilter

getValueFilter

setValueFilter

getContextValueFilter

setContextValueFilter

getContextNameFilter

setContextNameFilter

getPropertyFilter

setPropertyFilter

getAfterFilter

setAfterFilter

getBeforeFilter

setBeforeFilter

getLabelFilter

setLabelFilter

getMaxLevel

setMaxLevel