io.github.benas.randombeans.FieldExclusionChecker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of random-beans Show documentation

Random Beans core implementation

There is a newer version: 3.9.0

/*
 * The MIT License
 *
 *   Copyright (c) 2016, Mahmoud Ben Hassine ([email protected])
 *
 *   Permission is hereby granted, free of charge, to any person obtaining a copy
 *   of this software and associated documentation files (the "Software"), to deal
 *   in the Software without restriction, including without limitation the rights
 *   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *   copies of the Software, and to permit persons to whom the Software is
 *   furnished to do so, subject to the following conditions:
 *
 *   The above copyright notice and this permission notice shall be included in
 *   all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 *   THE SOFTWARE.
 */

package io.github.benas.randombeans;

import io.github.benas.randombeans.annotation.Exclude;

import java.lang.reflect.Field;
import java.util.Set;

import static io.github.benas.randombeans.util.ReflectionUtils.isStatic;

/**
 * Component that encapsulates the logic of field exclusion in a given population context.
 * This class implements exclusion rules in the predefined order.
 *
 * @author Mahmoud Ben Hassine ([email protected])
 */
class FieldExclusionChecker {

    /**
     * Given the current population context, should the field be excluded from being populated ?
     *
     * @param field the field to check
     * @param context the current population context
     * @return true if the field should be excluded, false otherwise
     */
    boolean shouldBeExcluded(final Field field, final PopulatorContext context) {
        if (field.isAnnotationPresent(Exclude.class)) {
            return true;
        }
        if (isStatic(field)) {
            return true;
        }
        Set excludedFields = context.getExcludedFields();
        if (excludedFields.isEmpty()) {
            return false;
        }
        return excludedFields.contains(context.getFieldFullName(field));
    }
}