ExampleMatcher (Spring Data Core 1.12.7.RELEASE API)

java.lang.Object
- org.springframework.data.domain.ExampleMatcher

Type Parameters:

T -
```
public class ExampleMatcher
extends Object
```
Specification for property path matching to use in query by example (QBE). An ExampleMatcher can be created for a object type. Instances of ExampleMatcher can be either matching() or #typed(Class) and settings can be tuned with... methods in a fluent style. with... methods return a copy of the ExampleMatcher instance with the specified setting. Null-handling defaults to ExampleMatcher.NullHandler.IGNORE and case-sensitive ExampleMatcher.StringMatcher.DEFAULT string matching.
This class is immutable.

Since:

1.12

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ExampleMatcher.GenericPropertyMatcher` A generic property matcher that specifies `string matching` and case sensitivity.
`static class`	`ExampleMatcher.GenericPropertyMatchers` Predefined property matchers to create a `ExampleMatcher.GenericPropertyMatcher`.
`static interface`	`ExampleMatcher.MatcherConfigurer<T>` Callback to configure a matcher.
`static class`	`ExampleMatcher.NoOpPropertyValueTransformer`
`static class`	`ExampleMatcher.NullHandler` Null handling for creating criterion out of an `Example`.
`static class`	`ExampleMatcher.PropertySpecifier` Define specific property handling for a Dot-Path.
`static class`	`ExampleMatcher.PropertySpecifiers` Define specific property handling for Dot-Paths.
`static interface`	`ExampleMatcher.PropertyValueTransformer` Allows to transform the property value before it is used in the query.
`static class`	`ExampleMatcher.StringMatcher` Match modes for treatment of `String` values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExampleMatcher.StringMatcher`	`getDefaultStringMatcher()` Get defined `ExampleMatcher.StringMatcher`.
`Set<String>`	`getIgnoredPaths()`
`ExampleMatcher.NullHandler`	`getNullHandler()` Get defined null handling.
`ExampleMatcher.PropertySpecifiers`	`getPropertySpecifiers()`
`boolean`	`isIgnoreCaseEnabled()`
`boolean`	`isIgnoredPath(String path)`
`static ExampleMatcher`	`matching()` Create a new untyped `ExampleMatcher` including all non-null properties by default.
`ExampleMatcher`	`withIgnoreCase()` Returns a copy of this `ExampleMatcher` with ignoring case sensitivity by default.
`ExampleMatcher`	`withIgnoreCase(boolean defaultIgnoreCase)` Returns a copy of this `ExampleMatcher` with `defaultIgnoreCase`.
`ExampleMatcher`	`withIgnoreCase(String... propertyPaths)` Returns a copy of this `ExampleMatcher` with ignore case sensitivity for the `propertyPaths`.
`ExampleMatcher`	`withIgnoreNullValues()` Returns a copy of this `ExampleMatcher` with treatment for null values of `ExampleMatcher.NullHandler.IGNORE`.
`ExampleMatcher`	`withIgnorePaths(String... ignoredPaths)` Returns a copy of this `ExampleMatcher` with the specified `propertyPaths`.
`ExampleMatcher`	`withIncludeNullValues()` Returns a copy of this `ExampleMatcher` with treatment for null values of `ExampleMatcher.NullHandler.INCLUDE` .
`ExampleMatcher`	`withMatcher(String propertyPath, ExampleMatcher.GenericPropertyMatcher genericPropertyMatcher)` Returns a copy of this `ExampleMatcher` with the specified `GenericPropertyMatcher` for the `propertyPath`.
`ExampleMatcher`	`withMatcher(String propertyPath, ExampleMatcher.MatcherConfigurer<ExampleMatcher.GenericPropertyMatcher> matcherConfigurer)` Returns a copy of this `ExampleMatcher` with the specified `GenericPropertyMatcher` for the `propertyPath`.
`ExampleMatcher`	`withNullHandler(ExampleMatcher.NullHandler nullHandler)` Returns a copy of this `ExampleMatcher` with the specified `nullHandler`.
`ExampleMatcher`	`withStringMatcher(ExampleMatcher.StringMatcher defaultStringMatcher)` Returns a copy of this `ExampleMatcher` with the specified string matching of `defaultStringMatcher`.
`ExampleMatcher`	`withTransformer(String propertyPath, ExampleMatcher.PropertyValueTransformer propertyValueTransformer)` Returns a copy of this `ExampleMatcher` with the specified `PropertyValueTransformer` for the `propertyPath`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - matching
```
public static ExampleMatcher matching()
```
    Create a new untyped ExampleMatcher including all non-null properties by default.
    
    Parameters:
    
    type - must not be null.
    
    Returns:
  - withIgnorePaths
```
public ExampleMatcher withIgnorePaths(String... ignoredPaths)
```
    Returns a copy of this ExampleMatcher with the specified propertyPaths. This instance is immutable and unaffected by this method call.
    
    Parameters:
    
    ignoredPaths - must not be null and not empty.
    
    Returns:
  - withStringMatcher
```
public ExampleMatcher withStringMatcher(ExampleMatcher.StringMatcher defaultStringMatcher)
```
    Returns a copy of this ExampleMatcher with the specified string matching of defaultStringMatcher. This instance is immutable and unaffected by this method call.
    
    Parameters:
    
    defaultStringMatcher - must not be null.
    
    Returns:
  - withIgnoreCase
```
public ExampleMatcher withIgnoreCase()
```
    Returns a copy of this ExampleMatcher with ignoring case sensitivity by default. This instance is immutable and unaffected by this method call.
    
    Returns:
  - withIgnoreCase
```
public ExampleMatcher withIgnoreCase(boolean defaultIgnoreCase)
```
    Returns a copy of this ExampleMatcher with defaultIgnoreCase. This instance is immutable and unaffected by this method call.
    
    Parameters:
    
    defaultIgnoreCase -
    
    Returns:
  - withMatcher
```
public ExampleMatcher withMatcher(String propertyPath,
                                  ExampleMatcher.MatcherConfigurer<ExampleMatcher.GenericPropertyMatcher> matcherConfigurer)
```
    Returns a copy of this ExampleMatcher with the specified GenericPropertyMatcher for the propertyPath. This instance is immutable and unaffected by this method call.
    
    Parameters:
    
    propertyPath - must not be null.
    
    matcherConfigurer - callback to configure a ExampleMatcher.GenericPropertyMatcher, must not be null.
    
    Returns:
  - withMatcher
```
public ExampleMatcher withMatcher(String propertyPath,
                                  ExampleMatcher.GenericPropertyMatcher genericPropertyMatcher)
```
    Returns a copy of this ExampleMatcher with the specified GenericPropertyMatcher for the propertyPath. This instance is immutable and unaffected by this method call.
    
    Parameters:
    
    propertyPath - must not be null.
    
    genericPropertyMatcher - callback to configure a ExampleMatcher.GenericPropertyMatcher, must not be null.
    
    Returns:
  - withTransformer
```
public ExampleMatcher withTransformer(String propertyPath,
                                      ExampleMatcher.PropertyValueTransformer propertyValueTransformer)
```
    Returns a copy of this ExampleMatcher with the specified PropertyValueTransformer for the propertyPath.
    
    Parameters:
    
    propertyPath - must not be null.
    
    propertyValueTransformer - must not be null.
    
    Returns:
  - withIgnoreCase
```
public ExampleMatcher withIgnoreCase(String... propertyPaths)
```
    Returns a copy of this ExampleMatcher with ignore case sensitivity for the propertyPaths. This instance is immutable and unaffected by this method call.
    
    Parameters:
    
    propertyPaths - must not be null and not empty.
    
    Returns:
  - withIncludeNullValues
```
public ExampleMatcher withIncludeNullValues()
```
    Returns a copy of this ExampleMatcher with treatment for null values of ExampleMatcher.NullHandler.INCLUDE . This instance is immutable and unaffected by this method call.
    
    Returns:
  - withIgnoreNullValues
```
public ExampleMatcher withIgnoreNullValues()
```
    Returns a copy of this ExampleMatcher with treatment for null values of ExampleMatcher.NullHandler.IGNORE. This instance is immutable and unaffected by this method call.
    
    Returns:
  - withNullHandler
```
public ExampleMatcher withNullHandler(ExampleMatcher.NullHandler nullHandler)
```
    Returns a copy of this ExampleMatcher with the specified nullHandler. This instance is immutable and unaffected by this method call.
    
    Parameters:
    
    nullHandler - must not be null.
    
    Returns:
  - getNullHandler
```
public ExampleMatcher.NullHandler getNullHandler()
```
    Get defined null handling.
    
    Returns:
    
    never null
  - getDefaultStringMatcher
```
public ExampleMatcher.StringMatcher getDefaultStringMatcher()
```
    Get defined ExampleMatcher.StringMatcher.
    
    Returns:
    
    never null.
  - isIgnoreCaseEnabled
```
public boolean isIgnoreCaseEnabled()
```
    Returns:
    
    true if String should be matched with ignore case option.
  - isIgnoredPath
```
public boolean isIgnoredPath(String path)
```
    Parameters:
    
    path -
    
    Returns:
    
    return true if path was set to be ignored.
  - getIgnoredPaths
```
public Set<String> getIgnoredPaths()
```
    Returns:
    
    unmodifiable Set of ignored paths.
  - getPropertySpecifiers
```
public ExampleMatcher.PropertySpecifiers getPropertySpecifiers()
```
    Returns:
    
    the ExampleMatcher.PropertySpecifiers within the ExampleMatcher.

Class ExampleMatcher

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

matching

withIgnorePaths

withStringMatcher

withIgnoreCase

withIgnoreCase

withMatcher

withMatcher

withTransformer

withIgnoreCase

withIncludeNullValues

withIgnoreNullValues

withNullHandler

getNullHandler

getDefaultStringMatcher

isIgnoreCaseEnabled

isIgnoredPath

getIgnoredPaths

getPropertySpecifiers