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