net.kaczmarzyk.spring.data.jpa.web.annotation

Annotation Type Spec

@Retention(value=RUNTIME)
 @Target(value={PARAMETER,TYPE})
public @interface Spec

Author:

Tomasz Kaczmarzyk, Matt S.Y. Ho

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	path
Class<? extends org.springframework.data.jpa.domain.Specification>	spec

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	config
String[]	constVal The constant value designed for specification without related HTTP param.
String[]	defaultVal The default value to use as a fallback when the request parameter is not provided or has an empty value.
OnTypeMismatch	onTypeMismatch
String[]	params
char	paramSeparator Character used to param delimitation.
String[]	pathVars
boolean	valueInSpEL Attribute determines that constVal/defaultVal value is in SpEL (Spring Expression Language) format.

Element Detail

path

public abstract String path

spec

public abstract Class<? extends org.springframework.data.jpa.domain.Specification> spec

params

public abstract String[] params

Default:

{}

paramSeparator

public abstract char paramSeparator

Character used to param delimitation. Param delimitation is skipped when separator has a 0 value.

Default:

0

pathVars

public abstract String[] pathVars

Default:

{}

config

public abstract String[] config

Default:

{}

constVal

public abstract String[] constVal

The constant value designed for specification without related HTTP param. Const value can be a raw string or SpEL expression. SpEL expression require valueInSpEL to be set to true and SpecificationArgumentResolver to be properly with the AbstractApplicationContext, see README.md for details.

Supplying constVal() implicitly sets defaultVal() to empty

Default:

{}

defaultVal

public abstract String[] defaultVal

The default value to use as a fallback when the request parameter is not provided or has an empty value. Default value can be a raw string or SpEL expression (could SpecificationArgumentResolver. SpEL expression require valueInSpEL to be set to true and SpecificationArgumentResolver to be properly with the AbstractApplicationContext, see README.md for details.

Supplying constVal() implicitly sets defaultVal() to empty

Default:

{}

valueInSpEL

public abstract boolean valueInSpEL

Attribute determines that constVal/defaultVal value is in SpEL (Spring Expression Language) format. Attribute is ignored when SpEL support is disabled, see README.md to get more information about enabling/disabling SpEL support.

Default:

false

onTypeMismatch

public abstract OnTypeMismatch onTypeMismatch

Default:

net.kaczmarzyk.spring.data.jpa.web.annotation.OnTypeMismatch.EMPTY_RESULT