Browse Source
We now provide HandlerMethodArgumentResolver interfaces to resolve Sort and Pageable method arguments with typed return values.pull/186/merge
5 changed files with 123 additions and 8 deletions
@ -0,0 +1,51 @@ |
|||||||
|
/* |
||||||
|
* Copyright 2016 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. |
||||||
|
* You may obtain a copy of the License at |
||||||
|
* |
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
* |
||||||
|
* Unless required by applicable law or agreed to in writing, software |
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS, |
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||||
|
* See the License for the specific language governing permissions and |
||||||
|
* limitations under the License. |
||||||
|
*/ |
||||||
|
package org.springframework.data.web; |
||||||
|
|
||||||
|
import org.springframework.core.MethodParameter; |
||||||
|
import org.springframework.data.domain.Pageable; |
||||||
|
import org.springframework.web.bind.WebDataBinder; |
||||||
|
import org.springframework.web.bind.support.WebDataBinderFactory; |
||||||
|
import org.springframework.web.context.request.NativeWebRequest; |
||||||
|
import org.springframework.web.method.support.HandlerMethodArgumentResolver; |
||||||
|
import org.springframework.web.method.support.ModelAndViewContainer; |
||||||
|
|
||||||
|
/** |
||||||
|
* Argument resolver to extract a {@link Pageable} object from a {@link NativeWebRequest} for a particular |
||||||
|
* {@link MethodParameter}. A {@link PageableArgumentResolver} can either resolve {@link Pageable} itself or wrap |
||||||
|
* another {@link PageableArgumentResolver} to post-process {@link Pageable}. {@link Pageable} resolution yields either |
||||||
|
* in a {@link Pageable} object or {@literal null} if {@link Pageable} cannot be resolved. |
||||||
|
* |
||||||
|
* @author Mark Paluch |
||||||
|
* @since 1.13 |
||||||
|
* @see org.springframework.web.method.support.HandlerMethodArgumentResolver |
||||||
|
*/ |
||||||
|
public interface PageableArgumentResolver extends HandlerMethodArgumentResolver { |
||||||
|
|
||||||
|
/** |
||||||
|
* Resolves a {@link Pageable} method parameter into an argument value from a given request. |
||||||
|
* |
||||||
|
* @param parameter the method parameter to resolve. This parameter must have previously been passed to |
||||||
|
* {@link #supportsParameter} which must have returned {@code true}. |
||||||
|
* @param mavContainer the ModelAndViewContainer for the current request |
||||||
|
* @param webRequest the current request |
||||||
|
* @param binderFactory a factory for creating {@link WebDataBinder} instances |
||||||
|
* @return the resolved argument value, or {@code null} |
||||||
|
*/ |
||||||
|
@Override |
||||||
|
Pageable resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, |
||||||
|
WebDataBinderFactory binderFactory); |
||||||
|
} |
||||||
@ -0,0 +1,51 @@ |
|||||||
|
/* |
||||||
|
* Copyright 2016 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. |
||||||
|
* You may obtain a copy of the License at |
||||||
|
* |
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
* |
||||||
|
* Unless required by applicable law or agreed to in writing, software |
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS, |
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||||
|
* See the License for the specific language governing permissions and |
||||||
|
* limitations under the License. |
||||||
|
*/ |
||||||
|
package org.springframework.data.web; |
||||||
|
|
||||||
|
import org.springframework.core.MethodParameter; |
||||||
|
import org.springframework.data.domain.Sort; |
||||||
|
import org.springframework.web.bind.WebDataBinder; |
||||||
|
import org.springframework.web.bind.support.WebDataBinderFactory; |
||||||
|
import org.springframework.web.context.request.NativeWebRequest; |
||||||
|
import org.springframework.web.method.support.HandlerMethodArgumentResolver; |
||||||
|
import org.springframework.web.method.support.ModelAndViewContainer; |
||||||
|
|
||||||
|
/** |
||||||
|
* Argument resolver to extract a {@link Sort} object from a {@link NativeWebRequest} for a particular |
||||||
|
* {@link MethodParameter}. A {@link SortArgumentResolver} can either resolve {@link Sort} itself or wrap another |
||||||
|
* {@link SortArgumentResolver} to post-process {@link Sort}. {@link Sort} resolution yields either in a {@link Sort} |
||||||
|
* object or {@literal null} if {@link Sort} cannot be resolved. |
||||||
|
* |
||||||
|
* @author Mark Paluch |
||||||
|
* @since 1.13 |
||||||
|
* @see org.springframework.web.method.support.HandlerMethodArgumentResolver |
||||||
|
*/ |
||||||
|
public interface SortArgumentResolver extends HandlerMethodArgumentResolver { |
||||||
|
|
||||||
|
/** |
||||||
|
* Resolves a {@link Sort} method parameter into an argument value from a given request. |
||||||
|
* |
||||||
|
* @param parameter the method parameter to resolve. This parameter must have previously been passed to |
||||||
|
* {@link #supportsParameter} which must have returned {@code true}. |
||||||
|
* @param mavContainer the ModelAndViewContainer for the current request |
||||||
|
* @param webRequest the current request |
||||||
|
* @param binderFactory a factory for creating {@link WebDataBinder} instances |
||||||
|
* @return the resolved argument value, or {@code null} |
||||||
|
*/ |
||||||
|
@Override |
||||||
|
Sort resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, |
||||||
|
WebDataBinderFactory binderFactory); |
||||||
|
} |
||||||
Loading…
Reference in new issue