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.validation;
018
019import org.springframework.lang.Nullable;
020
021/**
022 * A strategy interface for formatting message codes.
023 *
024 * @author Chris Beams
025 * @since 3.2
026 * @see DefaultMessageCodesResolver
027 * @see DefaultMessageCodesResolver.Format
028 */
029public interface MessageCodeFormatter {
030
031        /**
032         * Build and return a message code consisting of the given fields,
033         * usually delimited by {@link DefaultMessageCodesResolver#CODE_SEPARATOR}.
034         * @param errorCode e.g.: "typeMismatch"
035         * @param objectName e.g.: "user"
036         * @param field e.g. "age"
037         * @return concatenated message code, e.g.: "typeMismatch.user.age"
038         * @see DefaultMessageCodesResolver.Format
039         */
040        String format(String errorCode, @Nullable String objectName, @Nullable String field);
041
042}