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.core; 018 019/** 020 * Interface that can be implemented by exceptions etc that are error coded. 021 * The error code is a String, rather than a number, so it can be given 022 * user-readable values, such as "object.failureDescription". 023 * 024 * <p>An error code can be resolved by a MessageSource, for example. 025 * 026 * @author Rod Johnson 027 * @see org.springframework.context.MessageSource 028 * @deprecated as of Spring Framework 4.3.6 029 */ 030@Deprecated 031public interface ErrorCoded { 032 033 /** 034 * Return the error code associated with this failure. 035 * The GUI can render this any way it pleases, allowing for localization etc. 036 * @return a String error code associated with this failure, 037 * or {@code null} if not error-coded 038 */ 039 String getErrorCode(); 040 041}