Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Introduce alias for 'value' attribute in @MatrixVariable

Browse Source 
Issue: SPR-11393
This commit is contained in:
Sam Brannen
2015-05-31 18:50:35 +02:00
parent 60eb9e9ca2
commit 1a56b47502
5 changed files with 42 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
spring-web/src/main/java/org/springframework/web/bind/annotation/MatrixVariable.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2014 the original author or authors.
* Copyright 2002-2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -22,6 +22,8 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.core.annotation.AliasFor;
/**
* Annotation which indicates that a method parameter should be bound to a
* name-value pair within a path segment. Supported for {@link RequestMapping}
@@ -37,6 +39,7 @@ import java.lang.annotation.Target;
* matrix variable names and values.
*
* @author Rossen Stoyanchev
* @author Sam Brannen
* @since 3.2
*/
@Target(ElementType.PARAMETER)
@@ -45,10 +48,19 @@ import java.lang.annotation.Target;
public @interface MatrixVariable {
/**
* The name of the matrix variable.
* Alias for {@link #name}.
*/
@AliasFor(attribute = "name")
String value() default "";
/**
* The name of the matrix variable.
* @since 4.2
* @see #value
*/
@AliasFor(attribute = "value")
String name() default "";
/**
* The name of the URI path variable where the matrix variable is located,
* if necessary for disambiguation (e.g. a matrix variable with the same
@@ -58,17 +70,18 @@ public @interface MatrixVariable {
/**
* Whether the matrix variable is required.
* <p>Default is {@code true}, leading to an exception thrown in case
* of the variable missing in the request. Switch this to {@code false}
* if you prefer a {@code null} in case of the variable missing.
* <p>Alternatively, provide a {@link #defaultValue() defaultValue},
* which implicitly sets this flag to {@code false}.
* <p>Default is {@code true}, leading to an exception being thrown in
* case the variable is missing in the request. Switch this to {@code false}
* if you prefer a {@code null} if the variable is missing.
* <p>Alternatively, provide a {@link #defaultValue}, which implicitly sets
* this flag to {@code false}.
*/
boolean required() default true;
/**
* The default value to use as a fallback. Supplying a default value implicitly
* sets {@link #required()} to false.
* The default value to use as a fallback.
* <p>Supplying a default value implicitly sets {@link #required} to
* {@code false}.
*/
String defaultValue() default ValueConstants.DEFAULT_NONE;