supportsContext method

  1. @override
bool supportsContext(
  1. SerializationContext<Generator> context
)

Determines whether this serializer supports the given serialization context.

The method allows serializers to indicate whether they are capable of handling objects within the provided context. This can include:

  • Checking global configuration flags in the context
  • Inspecting the currently active naming strategy
  • Determining compatibility with format-specific rules (JSON, YAML, etc.)

Returns:

  • true → if this serializer can operate correctly within the provided context
  • false → if the serializer cannot safely handle serialization for the current context

Example

final context = SerializationContext.default();
if (serializer.supports(context)) {
  serializer.serialize(user, generator, context);
}

Notes

  • This method is often used internally by the serialization framework to select appropriate serializers dynamically.
  • Implementations may consider format-specific capabilities, feature flags, or runtime conditions when deciding support.

Implementation

@override
bool supportsContext(SerializationContext context) => context is JsonSerializationContext;