com.cisco.oss.foundation.application.exception.ErrorCode Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015 Cisco Systems, Inc.
 *
 *  Licensed under the Apache License, Version 2.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.apache.org/licenses/LICENSE-2.0
 *
 *  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 com.cisco.oss.foundation.application.exception;


/**
 * This class defined the error details of any application error.
 * It holds a component Id and an error code that should be created by the low level component that originates the exception.
 * The same instance should be aggregated to the wrapping exception until it gets to highest level where it is logged to the  client system.
 * The ErrorCode is wrapped under .
 * @author Yair Ogen
 * @author Joel Gurfinkel
 */
public class ErrorCode implements ErrorCodeInterface {
	

	private static final long serialVersionUID = 5364995786467605380L;
	private final String componentId;
	private final int code;
	
	public ErrorCode(final String componentId, final int code) {
		this.componentId = componentId;
		this.code = code;
	}

	public String getComponentId() {
		return componentId;
	}
	
	public int getCode() {
		return code;
	}
	
	
	@Override
	public int hashCode() {
		int result = 1;
		result = 31 * result + code;
		result = 31 * result + ((componentId == null) ? 0 : componentId.hashCode());
		return result;
	}

	@Override
	public boolean equals(Object obj) {// NOPMD

		if (this == obj) {
			return true;
		}

		if (obj == null) {
			return false;
		}

		if (getClass() != obj.getClass()) {
			return false;
		}

		final ErrorCode other = (ErrorCode) obj;
		if (code != other.code) {
			return false;
		}

		if (componentId == null) {
			
			if (other.componentId != null) {
				return false;
			}
			
		} else if (!componentId.equals(other.componentId)) {
			return false;
		}
		
		return true;
	}

		
	@Override
	public String toString() {
		return getComponentId() + '-' + getCode();
	}

}