org.springframework.data.web.OffsetScrollPositionArgumentResolver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-commons Show documentation
The newest version!
/*
 * Copyright 2023-2024 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
 *
 *      https://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.OffsetScrollPosition;
import org.springframework.lang.Nullable;
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 OffsetScrollPosition} object from a {@link NativeWebRequest} for a particular
 * {@link MethodParameter}. A {@link OffsetScrollPositionArgumentResolver} can either resolve
 * {@link OffsetScrollPosition} itself or wrap another {@link OffsetScrollPositionArgumentResolver} to post-process
 * {@link OffsetScrollPosition}.
 *
 * @author Yanming Zhou
 * @author Mark Paluch
 * @since 3.2
 * @see org.springframework.web.method.support.HandlerMethodArgumentResolver
 */
public interface OffsetScrollPositionArgumentResolver extends HandlerMethodArgumentResolver {

	/**
	 * Resolves a {@link OffsetScrollPosition} method parameter into an argument value from a given request. Supports also
	 * wrapped arguments in {@link java.util.Optional}.
	 *
	 * @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 {@literal null} if the value cannot be resolved. The returned value
	 *         considers {@link MethodParameter#isOptional() Optional} wrapping by returing either the value wrapped
	 *         within Optional or Optional.empty().
	 */
	@Override
	Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
			NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory);
}