io.micronaut.serde

Interface PropertyFilter

@Indexed(value=PropertyFilter.class)
public interface PropertyFilter

Models a build time property filter. That is a class computed at build-time that can be used to decide which bean properties to serialize. Use Named annotation to specify a name for the property filter.

Author:

Andriy Dmytruk

Method Summary

Modifier and Type	Method and Description
boolean	shouldInclude(Serializer.EncoderContext encoderContext, Serializer<java.lang.Object> propertySerializer, java.lang.Object bean, java.lang.String propertyName, java.lang.Object propertyValue)

Method Detail

shouldInclude

boolean shouldInclude(@NonNull
                      Serializer.EncoderContext encoderContext,
                      @NonNull
                      Serializer<java.lang.Object> propertySerializer,
                      @NonNull
                      java.lang.Object bean,
                      @NonNull
                      java.lang.String propertyName,
                      @Nullable
                      java.lang.Object propertyValue)

Parameters:

encoderContext - the encoder context

propertySerializer - the serializer of the property

bean - the object being serialized

propertyName - the name of the property

propertyValue - the property being serialized

Returns:

whether the property should be included in serialization