de.ppi.deepsampler.persistence.api.PersistentMatchers Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deepsampler-persistence Show documentation

This module is the core of the persistence api in DeepSampler.

There is a newer version: 2.1.0

Show newest version

/*
 * Copyright 2020  PPI AG (Hamburg, Germany)
 * This program is made available under the terms of the MIT License.
 */

package de.ppi.deepsampler.persistence.api;

import de.ppi.deepsampler.core.model.ParameterMatcher;
import de.ppi.deepsampler.core.model.SampleRepository;
import de.ppi.deepsampler.persistence.error.PersistenceException;

import java.util.Objects;

/**
 * This class is a collection of factory methods for some different types of {@link PersistentMatcher}.
 * 

 * Furthermore it offers a factory method for creating {@link ComboMatcher}s. Whenever you want to use {@link PersistentMatcher} it will be necessary to wrap them in a {@link ComboMatcher} with
 * the factory method {@link #combo(Object, PersistentMatcher)}. After that you can use the {@link ComboMatcher} like any other {@link ParameterMatcher}. The same rules which are valid for any
 * {@link ParameterMatcher} are applied to {@link ComboMatcher} as well.
 *
 * @see de.ppi.deepsampler.core.api.Matchers
 * @author Rico Schrage
 */
public class PersistentMatchers {

    private PersistentMatchers() {
        // static only
    }

    /**
     * Create a {@link ComboMatcher} with respect of making it available for the current {@link de.ppi.deepsampler.core.model.SampleDefinition}.
     *
     * @param parameterMatcher the parameterMatcher to be imitated by the {@link ComboMatcher}
     * @param persistentMatcher the persistentMatcher to be used as comparator (real value <-> persistent value)
     * @param  type to compare/match
     *
     * @return always returns null
     */
    @SuppressWarnings("unchecked")
    public static  T combo(T parameterMatcher, PersistentMatcher persistentMatcher) {
        if (SampleRepository.getInstance().getCurrentParameterMatchers().isEmpty()) {
            throw new PersistenceException("It wasn't possible to retrieve the last ParameterMatcher. Did you passed a ParameterMatcher created with a static factory method in de.ppi.deepsampler.core.api.Matchers?");
        }

        SampleRepository.getInstance().setCurrentParameterMatchers(new ComboMatcher<>((ParameterMatcher) SampleRepository.getInstance().getLastParameterMatcher(), persistentMatcher));
        return null;
    }

    /**
     * Create a {@link PersistentMatcher} for comparing two objects using their equals method.
     *
     * @param  type to compare
     * @return the created {@link PersistentMatcher}
     */
    public static  PersistentMatcher equalsMatcher() {
        return Objects::equals;
    }

    /**
     * Create a {@link PersistentMatcher} for comparing two objects by memory address (objOne == objTwo).
     * @param  type to compare
     * @return the {@link PersistentMatcher}
     */
    public static  PersistentMatcher sameMatcher() {
        return (first, second) -> first == second;
    }
 }