Package net.kaczmarzyk.spring.data.jpa.utils

Class SpecificationBuilder<T extends org.springframework.data.jpa.domain.Specification>

java.lang.Object

net.kaczmarzyk.spring.data.jpa.utils.SpecificationBuilder<T>

public final class SpecificationBuilder<T extends org.springframework.data.jpa.domain.Specification>
extends Object

SpecificationBuilder allows creating specification apart from web layer. It is recommended to use builder methods that corresponding to the type of argument passed to specification.

• params = <args> => withParam(<argName>, <values...>), single param argument can provide multiple values
• pathVars = <args> => withPathVar(<argName>, <value>), single pathVar argument can provide single value
• headers = <args> => withHeader(<argName>, <value>), single header argument can provide single value

Author:

Jakub Radlica, Kacper Leśniak (Tratif sp. z o.o.)

Method Summary

Modifier and Type	Method	Description
T	build()
static <T extends org.springframework.data.jpa.domain.Specification<?>> SpecificationBuilder<T>	specification(Class<T> specInterface)
SpecificationBuilder<T>	withArg(String arg, String... values)	The direct methods for params/headers/pathVars should be used in most common scenarios in order to avoid hard-to-debug errors.
SpecificationBuilder<T>	withHeader(String header, String value)
SpecificationBuilder<T>	withJsonBodyParam(String jsonPath, String... values)
SpecificationBuilder<T>	withParam(String param, String... values)
SpecificationBuilder<T>	withPathVar(String pathVar, String value)
SpecificationBuilder<T>	withSpecificationFactory(SpecificationFactory specificationFactory)

Methods inherited from class java.lang.Object

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

Method Details

specification

public static <T extends org.springframework.data.jpa.domain.Specification<?>>
SpecificationBuilder<T> specification(Class<T> specInterface)

withSpecificationFactory

public SpecificationBuilder<T> withSpecificationFactory(SpecificationFactory specificationFactory)

withArg

public SpecificationBuilder<T> withArg(String arg,
 String... values)

The direct methods for params/headers/pathVars should be used in most common scenarios in order to avoid hard-to-debug errors. Use this method only if you really understand how it works.

withParam

public SpecificationBuilder<T> withParam(String param,
 String... values)

withPathVar

public SpecificationBuilder<T> withPathVar(String pathVar,
 String value)

withHeader

public SpecificationBuilder<T> withHeader(String header,
 String value)

withJsonBodyParam

public SpecificationBuilder<T> withJsonBodyParam(String jsonPath,
 String... values)

build

public T build()