org.springframework.data.domain

Class Example<T>

java.lang.Object

org.springframework.data.domain.Example<T>

Type Parameters:

T - the type of the probe.

public class Example<T>
extends Object

Support for query by example (QBE). An Example takes a probe to define the example. Matching options and type safety can be tuned using ExampleMatcher.

Since:

1.12

Author:

Christoph Strobl, Mark Paluch, Oliver Gierke

Constructor Summary

Constructors

Constructor and Description
Example()

Method Summary

Modifier and Type	Method and Description
ExampleMatcher	getMatcher() Get the ExampleMatcher used.
T	getProbe() Get the example used.
Class<T>	getProbeType() Get the actual type for the probe used.
static <T> Example<T>	of(T probe) Create a new Example including all non-null properties by default.
static <T> Example<T>	of(T probe, ExampleMatcher matcher) Create a new Example using the given ExampleMatcher.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Example

public Example()

Method Detail

of

public static <T> Example<T> of(T probe)

Create a new Example including all non-null properties by default.

Parameters:

probe - must not be null.

Returns:

of

public static <T> Example<T> of(T probe,
                                ExampleMatcher matcher)

Create a new Example using the given ExampleMatcher.

Parameters:

probe - must not be null.

matcher - must not be null.

Returns:

getProbe

public T getProbe()

Get the example used.

Returns:

never null.

getMatcher

public ExampleMatcher getMatcher()

Get the ExampleMatcher used.

Returns:

never null.

getProbeType

public Class<T> getProbeType()

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.

Returns:

See Also:

ClassUtils.getUserClass(Class)