com.sap.cloud.sdk.result.AnnotatedFieldGsonExclusionStrategy Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved.
 */

package com.sap.cloud.sdk.result;

import java.lang.annotation.Annotation;

import com.google.gson.ExclusionStrategy;
import com.google.gson.FieldAttributes;

import lombok.RequiredArgsConstructor;

/**
 * Implementation of GSON {@link ExclusionStrategy} excluding all fields not annotated with the given
 * annotation.
 * 
 * Typical use-case is the usage of an annotation like {@link ElementName}. JSON should only (de-)serialize fields
 * annotated with this annotation and ignore every other field.
 * 
 * @param 
 *            The type of the annotation to check for.
 */
@RequiredArgsConstructor
public class AnnotatedFieldGsonExclusionStrategy implements ExclusionStrategy
{
    private final Class annotationClass;

    @Override
    public boolean shouldSkipField( final FieldAttributes fieldAttributes )
    {
        return fieldAttributes.getAnnotation(annotationClass) == null;
    }

    @Override
    public boolean shouldSkipClass( final Class cls )
    {
        return false;
    }
}