com.intuit.wasabi.tests.library.util.serialstrategies.DefaultNameExclusionStrategy.java Source code

Introduction

Here is the source code for com.intuit.wasabi.tests.library.util.serialstrategies.DefaultNameExclusionStrategy.java

Source

/*******************************************************************************
 * Copyright 2016 Intuit
 *
 * 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.intuit.wasabi.tests.library.util.serialstrategies;

import com.google.gson.FieldAttributes;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/**
 * Implements a SerializationStrategy which only allows fields which have no blacklisted names.
 */
public class DefaultNameExclusionStrategy implements SerializationStrategy {

    /** the blacklist */
    private List<String> blacklist;

    /**
     * Blacklists method names.
     *
     * @param includes names to blacklist.
     */
    public DefaultNameExclusionStrategy(String... includes) {
        blacklist = new ArrayList<>(includes.length);
        add(includes);
    }

    /**
     * Skips fields if their names are on the blacklist.
     *
     * @param fieldAttributes the field attributes
     * @return true if the field name is in the blacklist
     */
    @Override
    public boolean shouldSkipField(FieldAttributes fieldAttributes) {
        return blacklist.contains(fieldAttributes.getName());
    }

    @Override
    public boolean shouldSkipClass(Class<?> aClass) {
        return false;
    }

    /**
     * Adds identifiers to the exclusion strategy.
     *
     * @param identifiers the modifiers to be added.
     */
    @Override
    public void add(String... identifiers) {
        blacklist.addAll(Arrays.asList(identifiers));
    }

    /**
     * Removes identifiers from the serialization strategy.
     *
     * @param identifiers the modifiers to be removed.
     */
    @Override
    public void remove(String... identifiers) {
        blacklist.removeAll(Arrays.asList(identifiers));
    }

    /**
     * Checks if an identifier is contained in this strategy.
     *
     * @param identifier the identifier to be checked.
     * @return true if identifier is in this strategy.
     */
    @Override
    public boolean contains(String identifier) {
        return blacklist.contains(identifier);
    }

    /**
     * Checks if the given identifier should be included.
     *
     * @param identifier the identifier to be checked.
     * @return true if identifier not blacklisted.
     */
    @Override
    public boolean include(String identifier) {
        return !blacklist.contains(identifier);
    }

    /**
     * Checks if the given identifier should be excluded.
     *
     * @param identifier the identifier to be checked.
     * @return true if identifier is blacklisted.
     */
    @Override
    public boolean exclude(String identifier) {
        return blacklist.contains(identifier);
    }

    /**
     * Returns an explanation how this strategy works.
     *
     * @return this strategy in a human readable manner
     */
    @Override
    public String toString() {
        return this.getClass().getSimpleName() + ": Excludes fields with these names: " + blacklist.toString();
    }
}