001/*
002 * Copyright 2002-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.web.bind.support;
018
019import org.springframework.lang.Nullable;
020import org.springframework.web.bind.WebDataBinder;
021import org.springframework.web.context.request.NativeWebRequest;
022
023/**
024 * A factory for creating a {@link WebDataBinder} instance for a named target object.
025 *
026 * @author Arjen Poutsma
027 * @since 3.1
028 */
029public interface WebDataBinderFactory {
030
031        /**
032         * Create a {@link WebDataBinder} for the given object.
033         * @param webRequest the current request
034         * @param target the object to create a data binder for,
035         * or {@code null} if creating a binder for a simple type
036         * @param objectName the name of the target object
037         * @return the created {@link WebDataBinder} instance, never null
038         * @throws Exception raised if the creation and initialization of the data binder fails
039         */
040        WebDataBinder createBinder(NativeWebRequest webRequest, @Nullable Object target, String objectName)
041                        throws Exception;
042
043}