org.springframework.data.domain.Example.java Source code

Introduction

Here is the source code for org.springframework.data.domain.Example.java

Source

/*
 * Copyright 2016-2019 the original author or authors.
 *
 * 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
 *
 *      https://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 org.springframework.data.domain;

import org.springframework.data.util.ProxyUtils;

/**
 * Support for query by example (QBE). An {@link Example} takes a {@code probe} to define the example. Matching options
 * and type safety can be tuned using {@link ExampleMatcher}.
 *
 * @author Christoph Strobl
 * @author Mark Paluch
 * @author Oliver Gierke
 * @param <T> the type of the probe.
 * @since 1.12
 */
public interface Example<T> {

    /**
     * Create a new {@link Example} including all non-null properties by default.
     *
     * @param probe must not be {@literal null}.
     * @return
     */
    static <T> Example<T> of(T probe) {
        return new TypedExample<>(probe, ExampleMatcher.matching());
    }

    /**
     * Create a new {@link Example} using the given {@link ExampleMatcher}.
     *
     * @param probe must not be {@literal null}.
     * @param matcher must not be {@literal null}.
     * @return
     */
    static <T> Example<T> of(T probe, ExampleMatcher matcher) {
        return new TypedExample<>(probe, matcher);
    }

    /**
     * Get the example used.
     *
     * @return never {@literal null}.
     */
    T getProbe();

    /**
     * Get the {@link ExampleMatcher} used.
     *
     * @return never {@literal null}.
     */
    ExampleMatcher getMatcher();

    /**
     * Get the actual type for the probe used. This is usually the given class, but the original class in case of a
     * CGLIB-generated subclass.
     *
     * @return
     * @see ProxyUtils#getUserClass(Class)
     */
    @SuppressWarnings("unchecked")
    default Class<T> getProbeType() {
        return (Class<T>) ProxyUtils.getUserClass(getProbe().getClass());
    }
}