org.tinygroup.exception.Error Maven / Gradle / Ivy
/**
* Copyright (c) 1997-2013, www.tinygroup.org ([email protected]).
*
* Licensed under the GPL, Version 3.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.gnu.org/licenses/gpl.html
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.tinygroup.exception;
import org.tinygroup.exception.errorcode.AbstractErrorCode;
/**
* 标准错误对象。
*
* 标准错误对象包含:
*
* - 标准错误码
* - 错误默认文案
* - 错误产生位置
*
* 标准错误对象是一次错误处理结果的描述。
*/
public class Error implements java.io.Serializable {
/**
* 序列ID
*/
private static final long serialVersionUID = -5421371978945260773L;
/**
* 错误编码
*/
private ErrorCode errorCode;
/**
* 错误描述
*/
private String errorMsg;
/**
* 错误发生系统
*/
private String errorSource;
// ~~~ 构造方法
/**
* 默认构造方法
*/
public Error() {
}
/**
* 构造方法
*
* @param code
* @param msg
*/
public Error(AbstractErrorCode code, String msg, String location) {
this.errorCode = code;
this.errorMsg = msg;
this.errorSource = location;
}
// ~~~ 公共方法
/**
* 转化为简单字符串表示。
*
* @return
*/
public String toDigest() {
return errorCode + "@" + errorSource;
}
// ~~~ 重写方法
/**
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return errorCode + "@" + errorSource + "::" + errorMsg;
}
// ~~~ bean方法
/**
* Getter method for property errorCode.
*
* @return property value of errorCode
*/
public ErrorCode getErrorCode() {
return errorCode;
}
/**
* Setter method for property errorCode.
*
* @param errorCode value to be assigned to property errorCode
*/
public void setErrorCode(ErrorCode errorCode) {
this.errorCode = errorCode;
}
/**
* Getter method for property errorMsg.
*
* @return property value of errorMsg
*/
public String getErrorMsg() {
return errorMsg;
}
/**
* Setter method for property errorMsg.
*
* @param errorMsg value to be assigned to property errorMsg
*/
public void setErrorMsg(String errorMsg) {
this.errorMsg = errorMsg;
}
/**
* Getter method for property errorSource.
*
* @return property value of errorSource
*/
public String getErrorSource() {
return errorSource;
}
/**
* Setter method for property errorSource.
*
* @param errorSource value to be assigned to property errorSource
*/
public void setErrorSource(String errorSource) {
this.errorSource = errorSource;
}
}