org.broadleafcommerce.frameworkmapping.annotation

Annotation Type FrameworkPatchMapping

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Documented
 @FrameworkMapping(method=PATCH)
public @interface FrameworkPatchMapping

Annotation for mapping HTTP PATCH requests onto specific handler methods.

Specifically, @FrameworkPatchMapping is a composed annotation that acts as a shortcut for @FrameworkMapping(method = RequestMethod.PATCH).

Author:

Samarth Dhruva (samarthd)

See Also:

FrameworkGetMapping, FrameworkPostMapping, FrameworkPutMapping, FrameworkDeleteMapping, FrameworkMapping

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	consumes Alias for FrameworkMapping.consumes().
String[]	headers Alias for FrameworkMapping.headers().
String	name Alias for FrameworkMapping.name().
String[]	params Alias for FrameworkMapping.params().
String[]	path Alias for FrameworkMapping.path().
String[]	produces Alias for FrameworkMapping.produces().
String[]	value Alias for FrameworkMapping.value().

Element Detail

name

@AliasFor(annotation=FrameworkMapping.class)
public abstract String name

Alias for FrameworkMapping.name().

Default:

""

value

@AliasFor(annotation=FrameworkMapping.class)
public abstract String[] value

Alias for FrameworkMapping.value().

Default:

{}

path

@AliasFor(annotation=FrameworkMapping.class)
public abstract String[] path

Alias for FrameworkMapping.path().

Default:

{}

params

@AliasFor(annotation=FrameworkMapping.class)
public abstract String[] params

Alias for FrameworkMapping.params().

Default:

{}

headers

@AliasFor(annotation=FrameworkMapping.class)
public abstract String[] headers

Alias for FrameworkMapping.headers().

Default:

{}

consumes

@AliasFor(annotation=FrameworkMapping.class)
public abstract String[] consumes

Alias for FrameworkMapping.consumes().

Default:

{}

produces

@AliasFor(annotation=FrameworkMapping.class)
public abstract String[] produces

Alias for FrameworkMapping.produces().

Default:

{}