001/*
002 * Copyright 2002-2018 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.servlet.tags;
018
019import java.beans.PropertyEditor;
020
021import javax.servlet.jsp.JspException;
022
023import org.springframework.lang.Nullable;
024
025/**
026 * Interface to be implemented by JSP tags that expose a
027 * PropertyEditor for a property that they are currently bound to.
028 *
029 * @author Juergen Hoeller
030 * @since 2.5
031 * @see BindTag
032 * @see org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag
033 */
034public interface EditorAwareTag {
035
036        /**
037         * Retrieve the PropertyEditor for the property that this tag is
038         * currently bound to. Intended for cooperating nesting tags.
039         * @return the current PropertyEditor, or {@code null} if none
040         * @throws JspException if resolving the editor failed
041         */
042        @Nullable
043        PropertyEditor getEditor() throws JspException;
044
045}