com.shazam.shazamcrest.GsonProvider.java Source code

Introduction

Here is the source code for com.shazam.shazamcrest.GsonProvider.java

Source

/*
 * Copyright 2013 Shazam Entertainment Limited
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
 * 
 * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 */
package com.shazam.shazamcrest;

import java.util.List;

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

/**
 * Provides an instance of {@link Gson}. If any class type has been ignored on the matcher, the {@link Gson} provided
 * will include an {@link ExclusionStrategy} which will skip the serialisation/deserialisation of fields for that type.
 */
public class GsonProvider {
    private static Gson GSON = new GsonBuilder().enableComplexMapKeySerialization().setPrettyPrinting().create();

    /**
     * Returns a {@link Gson} instance containing {@link ExclusionStrategy} based on the object types to ignore during
     * serialisation/deserialisation.
     * 
     * @param typesToIgnore the object types to exclude from serialisation/deserialisation.
     * @return an instance of {@link Gson}
     */
    public static Gson gson(final List<Class<?>> typesToIgnore) {
        if (typesToIgnore.size() == 0) {
            return GsonProvider.GSON;
        } else {
            return new GsonBuilder().setPrettyPrinting().enableComplexMapKeySerialization()
                    .setExclusionStrategies(new ExclusionStrategy() {
                        @Override
                        public boolean shouldSkipField(FieldAttributes f) {
                            return false;
                        }

                        @Override
                        public boolean shouldSkipClass(Class<?> clazz) {
                            return (typesToIgnore.contains(clazz));
                        }

                    }).create();
        }
    }
}