com.github.karsaig.approvalcrest.matcher.CustomisableMatcher Maven / Gradle / Ivy
The newest version!
/*
* 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.github.karsaig.approvalcrest.matcher;
import org.hamcrest.Matcher;
import java.util.function.Function;
/**
* {@link Matcher} implementation where fields and object types can be skipped from the comparison, or matched with
* custom matchers.
*/
public interface CustomisableMatcher> extends Matcher {
/**
* Specify the path of the field to be skipped from the matcher comparison.
* Example:
* sameBeanAs(expected).ignoring("beanField.subBeanField")
*
* @param fieldPath the path of the field to be skipped from the comparison.
* @return the instance of the matcher
*/
U ignoring(String fieldPath);
/**
* Specify the path of the field to be skipped from the matcher comparison.
* Example:
* sameBeanAs(expected).ignoring("beanField.subBeanField","beanField2.subBeanField3")
*
* @param fieldPaths the paths of fields to be skipped from the comparison.
* @return the instance of the matcher
*/
U ignoring(String... fieldPaths);
/**
* Specify the object type of the fields to be skipped from the matcher comparison.
* Example:
* sameBeanAs(expected).ignoring(Bean.class)
*
* @param clazz the object type to be skipped from the comparison.
* @return the instance of the matcher
*/
U ignoring(Class clazz);
/**
* Specify the object types of the fields to be skipped from the matcher comparison.
* Example:
* sameBeanAs(expected).ignoring(Bean.class,Bean2.class)
*
* @param clazz the object types to be skipped from the comparison.
* @return the instance of the matcher
*/
U ignoring(Class... clazz);
/**
* Specify the path of the field to be matched with a specific matcher.
* Example:
* sameBeanAs(expected).with("beanField.subBeanField", contains("element"))
*
* @param fieldPath the path of the field to be matched with the provided matcher.
* @param matcher the Hamcrest matcher used to match the specified field.
* @param type of actual object to match
* @return the instance of the matcher
*/
U with(String fieldPath, Matcher matcher);
/**
* Specify a custom configuration for the Gson, for example, providing additional TypeAdapters.
*
* @param configuration {@link GsonConfiguration} object, containing TypeAdapterFactories, TypeAdapters and
* TypeHierarchyAdapters.
* @return the instance of the matcher
*/
U withGsonConfiguration(GsonConfiguration configuration);
/**
* Specify the pattern of field names to ignore. Any bean property with a name that
* matches the supplied pattern will be ignored.
* Example:
* assertThat(myBean, sameBeanAs(myResultBean).ignoring(is("mutationdate")).ignoring(containsString("version")))
*
* @param fieldNamePattern the Hamcrest matcher used to match field names.
* @return the instance of the matcher
*/
U ignoring(Matcher fieldNamePattern);
/**
* Specify the pattern of field names to ignore. Any bean property with a name that
* matches the supplied pattern will be ignored.
* Example:
* assertThat(myBean, sameBeanAs(myResultBean).ignoring(is("mutationdate",containsString("version"))))
*
* @param fieldNamePatterns the Hamcrest matchers used to match field names.
* @return the instance of the matcher
*/
@SuppressWarnings({"varargs", "unchecked"})
U ignoring(Matcher... fieldNamePatterns);
/**
* Specify function to be applied on fields in order to decide weather to include the field in circular reference check or not.
*
* @param matcher The {@link Function} to skip check, if it returns true the matching object the function applies to won't be checked for circular references.
* @return the instance of the matcher
*/
U skipCircularReferenceCheck(Function matcher);
/**
* Specify function to be applied on fields in order to decide weather to include the field in circular reference check or not.
*
* @param matcher The {@link Function} to skip check, if it returns true the matching object the function applies to won't be checked for circular references.
* @param matchers The {@link Function}s to skip check
* @return the instance of the matcher
*/
@SuppressWarnings({"unchecked", "varargs"})
U skipCircularReferenceCheck(Function matcher, Function... matchers);
/**
* Specify the pattern of field names to sort. Any bean property with a name that
* matches the supplied pattern will be sorted (if sortable).
* Example:
* assertThat(myBean, sameBeanAs(myResultBean).sortField(is("mutationdate")).sortField(containsString("version")))
*
* @param fieldNamePattern the Hamcrest matcher used to match field names.
* @return the instance of the matcher
*/
U sortField(Matcher fieldNamePattern);
/**
* Specify the pattern of field names to sort. Any bean property with a name that
* matches the supplied pattern will be sorted (if sortable).
* Example:
* assertThat(myBean, sameBeanAs(myResultBean).sortField(is("mutationdate",containsString("version"))))
*
* @param fieldNamePatterns the Hamcrest matchers used to match field names.
* @return the instance of the matcher
*/
@SuppressWarnings({"varargs", "unchecked"})
U sortField(Matcher... fieldNamePatterns);
/**
* Specify the path of the field to be sorted.
* Example:
* sameBeanAs(expected).sortField("beanField.subBeanField")
*
* @param fieldPath the path of the field to be sorted (if sortable).
* @return the instance of the matcher
*/
U sortField(String fieldPath);
/**
* Specify the path of the field to be sorted.
* Example:
* sameBeanAs(expected).sortField("beanField.subBeanField","beanField2.subBeanField3")
*
* @param fieldPaths the paths of fields to be sorted (if sortable).
* @return the instance of the matcher
*/
U sortField(String... fieldPaths);
}