ErrorCode.java - This Java class represents an error code f…

/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/ErrorCode.java

http://mobicents.googlecode.com/ · Java · 500 lines · 392 code · 101 blank · 7 comment · 2 complexity · a36110b5d3c0b048943e17e49e9bed52 MD5 · raw file

package javax.megaco;

import java.io.Serializable;

/**
 * This class defines the error codes which can be returned in the response
 * events from stack. These error codes would help the application in
 * identifying the granularity of the error occured.
 * 
 * 
 */
public class ErrorCode implements Serializable {

	public static final int M_MISSING_ENC_FORMAT = 1;
	public static final int M_TPT_ADDR_ALREADY_INUSE = 2;
	public static final int M_PEER_ENTITY_UNVBLE = 3;
	public static final int M_INV_LOCAL_TPT_ADDRESS = 4;
	public static final int M_INV_REMOTE_TPT_ADDRESS = 5;
	public static final int M_INV_LCL_RMT_ADDR_PAIR = 6;
	public static final int M_INV_ASSOC_ID = 7;
	public static final int M_MISSING_SVC_CHNG_METHOD = 8;
	public static final int M_INV_SVC_CHNG_METH_REASON_PAIR = 9;
	public static final int M_UNSPTD_ENC_FORMAT = 10;
	public static final int M_UNSPTD_TPT_TYPE = 11;
	public static final int M_INV_SVC_CHNG_ADDR = 12;
	public static final int M_INV_HOFF_MGCID = 13;
	public static final int M_UNSPTD_SVC_CHNG_METH_EXTN = 14;
	public static final int M_INV_SVC_CHNG_REASON = 15;
	public static final int M_INV_SVC_CHNG_METHOD = 16;
	public static final int M_RES_UNVBLE = 17;
	public static final int M_MODIFY_ENC_FORMAT_FAILURE = 18;
	public static final int M_MODIFY_TPT_TYPE_FAILURE = 19;
	public static final int M_MODIFY_SVC_PROFILE_FAILURE = 20;
	public static final int M_MODIFY_PROTOCOL_VERSION_FAILURE = 21;
	public static final int M_INV_ACTION_HANDLE = 22;
	public static final int M_WLDCRD_CMD_NOT_SUPTD = 23;
	public static final int M_INV_CMD_REQID = 24;
	public static final int M_INV_CMD_RESPID = 25;
	public static final int M_TERM_TYPE_NOT_INSYNCH = 26;
	public static final int M_INV_TERM_NAME_FORMAT = 27;
	public static final int M_TOPOLOGY_DESC_NOT_SUPTD = 28;
	public static final int M_MEDIA_DESC_NOT_SUPTD = 29;
	public static final int M_MODEM_DESC_NOT_SUPTD = 30;
	public static final int M_MUX_DESC_NOT_SUPTD = 31;
	public static final int M_EVENT_DESC_NOT_SUPTD = 32;
	public static final int M_SIGNAL_DESC_NOT_SUPTD = 33;
	public static final int M_DIGITMAP_DESC_NOT_SUPTD = 34;
	public static final int M_EVENTBUFF_DESC_NOT_SUPTD = 35;
	public static final int M_AUDIT_DESC_NOT_SUPTD = 36;
	public static final int M_OBSRD_EVENT_DESC_NOT_SUPTD = 37;
	public static final int M_STATS_DESC_NOT_SUPTD = 38;
	public static final int M_PCKG_DESC_NOT_SUPTD = 39;
	public static final int M_SDPINFO_NOT_SUPTD = 40;
	public static final int M_INV_PKG_ITEM_TYPE = 41;
	public static final int M_INV_CTXID_TERMTYPE_PAIR = 42;
	public static final int M_MISSING_LCL_TPT_ADDR = 43;
	public static final int M_MISSING_REMOTE_TPT_ADDR = 44;
	public static final int M_MISSING_SVC_CHNG_REASON = 45;

	public static final ErrorCode PEER_ENTITY_UNVBLE = new ErrorCode(M_PEER_ENTITY_UNVBLE);
	public static final ErrorCode INV_LOCAL_TPT_ADDRESS = new ErrorCode(M_INV_LOCAL_TPT_ADDRESS);
	public static final ErrorCode INV_REMOTE_TPT_ADDRESS = new ErrorCode(M_INV_REMOTE_TPT_ADDRESS);
	public static final ErrorCode INV_LCL_RMT_ADDR_PAIR = new ErrorCode(M_INV_LCL_RMT_ADDR_PAIR);
	public static final ErrorCode INV_ASSOC_ID = new ErrorCode(M_INV_ASSOC_ID);
	public static final ErrorCode INV_SVC_CHNG_METH_REASON_PAIR = new ErrorCode(M_INV_SVC_CHNG_METH_REASON_PAIR);
	public static final ErrorCode UNSPTD_ENC_FORMAT = new ErrorCode(M_UNSPTD_ENC_FORMAT);
	public static final ErrorCode UNSPTD_TPT_TYPE = new ErrorCode(M_UNSPTD_TPT_TYPE);
	public static final ErrorCode INV_SVC_CHNG_ADDR = new ErrorCode(M_INV_SVC_CHNG_ADDR);
	public static final ErrorCode INV_HOFF_MGCID = new ErrorCode(M_INV_HOFF_MGCID);
	public static final ErrorCode UNSPTD_SVC_CHNG_METH_EXTN = new ErrorCode(M_UNSPTD_SVC_CHNG_METH_EXTN);
	public static final ErrorCode INV_SVC_CHNG_REASON = new ErrorCode(M_INV_SVC_CHNG_REASON);
	public static final ErrorCode INV_SVC_CHNG_METHOD = new ErrorCode(M_INV_SVC_CHNG_METHOD);
	public static final ErrorCode RES_UNVBLE = new ErrorCode(M_RES_UNVBLE);
	public static final ErrorCode MODIFY_ENC_FORMAT_FAILURE = new ErrorCode(M_MODIFY_ENC_FORMAT_FAILURE);
	public static final ErrorCode MODIFY_TPT_TYPE_FAILURE = new ErrorCode(M_MODIFY_TPT_TYPE_FAILURE);
	public static final ErrorCode MODIFY_SVC_PROFILE_FAILURE = new ErrorCode(M_MODIFY_SVC_PROFILE_FAILURE);
	public static final ErrorCode MODIFY_PROTOCOL_VERSION_FAILURE = new ErrorCode(M_MODIFY_PROTOCOL_VERSION_FAILURE);
	public static final ErrorCode INV_ACTION_HANDLE = new ErrorCode(M_INV_ACTION_HANDLE);
	public static final ErrorCode WLDCRD_CMD_NOT_SUPTD = new ErrorCode(M_WLDCRD_CMD_NOT_SUPTD);
	public static final ErrorCode INV_CMD_REQID = new ErrorCode(M_INV_CMD_REQID);
	public static final ErrorCode INV_CMD_RESPID = new ErrorCode(M_INV_CMD_RESPID);
	public static final ErrorCode TERM_TYPE_NOT_INSYNCH = new ErrorCode(M_TERM_TYPE_NOT_INSYNCH);
	public static final ErrorCode INV_TERM_NAME_FORMAT = new ErrorCode(M_INV_TERM_NAME_FORMAT);
	public static final ErrorCode TOPOLOGY_DESC_NOT_SUPTD = new ErrorCode(M_TOPOLOGY_DESC_NOT_SUPTD);
	public static final ErrorCode MEDIA_DESC_NOT_SUPTD = new ErrorCode(M_MEDIA_DESC_NOT_SUPTD);
	public static final ErrorCode MODEM_DESC_NOT_SUPTD = new ErrorCode(M_MODEM_DESC_NOT_SUPTD);
	public static final ErrorCode MUX_DESC_NOT_SUPTD = new ErrorCode(M_MUX_DESC_NOT_SUPTD);
	public static final ErrorCode EVENT_DESC_NOT_SUPTD = new ErrorCode(M_EVENT_DESC_NOT_SUPTD);
	public static final ErrorCode SIGNAL_DESC_NOT_SUPTD = new ErrorCode(M_SIGNAL_DESC_NOT_SUPTD);
	public static final ErrorCode DIGITMAP_DESC_NOT_SUPTD = new ErrorCode(M_DIGITMAP_DESC_NOT_SUPTD);
	public static final ErrorCode EVENTBUFF_DESC_NOT_SUPTD = new ErrorCode(M_EVENTBUFF_DESC_NOT_SUPTD);
	public static final ErrorCode AUDIT_DESC_NOT_SUPTD = new ErrorCode(M_AUDIT_DESC_NOT_SUPTD);
	public static final ErrorCode OBSRD_EVENT_DESC_NOT_SUPTD = new ErrorCode(M_OBSRD_EVENT_DESC_NOT_SUPTD);
	public static final ErrorCode STATS_DESC_NOT_SUPTD = new ErrorCode(M_STATS_DESC_NOT_SUPTD);
	public static final ErrorCode PCKG_DESC_NOT_SUPTD = new ErrorCode(M_PCKG_DESC_NOT_SUPTD);
	public static final ErrorCode SDPINFO_NOT_SUPTD = new ErrorCode(M_SDPINFO_NOT_SUPTD);
	public static final ErrorCode INV_PKG_ITEM_TYPE = new ErrorCode(M_INV_PKG_ITEM_TYPE);
	public static final ErrorCode INV_CTXID_TERMTYPE_PAIR = new ErrorCode(M_INV_CTXID_TERMTYPE_PAIR);
	public static final ErrorCode MISSING_LCL_TPT_ADDR = new ErrorCode(M_MISSING_LCL_TPT_ADDR);
	public static final ErrorCode MISSING_REMOTE_TPT_ADDR = new ErrorCode(M_MISSING_REMOTE_TPT_ADDR);
	public static final ErrorCode MISSING_SVC_CHNG_REASON = new ErrorCode(M_MISSING_SVC_CHNG_REASON);
	public static final ErrorCode MISSING_SVC_CHNG_METHOD = new ErrorCode(M_MISSING_SVC_CHNG_METHOD);
	public static final ErrorCode MISSING_ENC_FORMAT = new ErrorCode(M_MISSING_ENC_FORMAT);
	public static final ErrorCode TPT_ADDR_ALREADY_INUSE = new ErrorCode(M_TPT_ADDR_ALREADY_INUSE);

	private int error_code;

	private ErrorCode(int error_code) {
		this.error_code = error_code;
	}

	public int getErrorCode() {
		return this.error_code;
	}

	public static final ErrorCode getObject(int value) throws IllegalArgumentException {
		ErrorCode e = null;
		switch (value) {
		case M_MISSING_ENC_FORMAT:
			e = MISSING_ENC_FORMAT;
			break;

		case M_TPT_ADDR_ALREADY_INUSE:
			e = TPT_ADDR_ALREADY_INUSE;
			break;

		case M_PEER_ENTITY_UNVBLE:
			e = PEER_ENTITY_UNVBLE;
			break;

		case M_INV_LOCAL_TPT_ADDRESS:
			e = INV_LOCAL_TPT_ADDRESS;
			break;

		case M_INV_REMOTE_TPT_ADDRESS:
			e = INV_REMOTE_TPT_ADDRESS;
			break;

		case M_INV_LCL_RMT_ADDR_PAIR:
			e = INV_LCL_RMT_ADDR_PAIR;
			break;

		case M_INV_ASSOC_ID:
			e = INV_ASSOC_ID;
			break;

		case M_MISSING_SVC_CHNG_METHOD:
			e = MISSING_SVC_CHNG_METHOD;
			break;

		case M_INV_SVC_CHNG_METH_REASON_PAIR:
			e = INV_SVC_CHNG_METH_REASON_PAIR;
			break;

		case M_UNSPTD_ENC_FORMAT:
			e = UNSPTD_ENC_FORMAT;
			break;

		case M_UNSPTD_TPT_TYPE:
			e = UNSPTD_TPT_TYPE;
			break;

		case M_INV_SVC_CHNG_ADDR:
			e = INV_SVC_CHNG_ADDR;
			break;

		case M_INV_HOFF_MGCID:
			e = INV_HOFF_MGCID;
			break;

		case M_UNSPTD_SVC_CHNG_METH_EXTN:
			e = UNSPTD_SVC_CHNG_METH_EXTN;
			break;

		case M_INV_SVC_CHNG_REASON:
			e = INV_SVC_CHNG_REASON;
			break;

		case M_INV_SVC_CHNG_METHOD:
			e = INV_SVC_CHNG_METHOD;
			break;

		case M_RES_UNVBLE:
			e = RES_UNVBLE;
			break;

		case M_MODIFY_ENC_FORMAT_FAILURE:
			e = MODIFY_ENC_FORMAT_FAILURE;
			break;

		case M_MODIFY_TPT_TYPE_FAILURE:
			e = MODIFY_TPT_TYPE_FAILURE;
			break;

		case M_MODIFY_SVC_PROFILE_FAILURE:
			e = MODIFY_SVC_PROFILE_FAILURE;
			break;

		case M_MODIFY_PROTOCOL_VERSION_FAILURE:
			e = MODIFY_PROTOCOL_VERSION_FAILURE;
			break;

		case M_INV_ACTION_HANDLE:
			e = INV_ACTION_HANDLE;
			break;

		case M_WLDCRD_CMD_NOT_SUPTD:
			e = WLDCRD_CMD_NOT_SUPTD;
			break;

		case M_INV_CMD_REQID:
			e = INV_CMD_REQID;
			break;

		case M_INV_CMD_RESPID:
			e = INV_CMD_RESPID;
			break;

		case M_TERM_TYPE_NOT_INSYNCH:
			e = TERM_TYPE_NOT_INSYNCH;
			break;

		case M_INV_TERM_NAME_FORMAT:
			e = INV_TERM_NAME_FORMAT;
			break;

		case M_TOPOLOGY_DESC_NOT_SUPTD:
			e = TOPOLOGY_DESC_NOT_SUPTD;
			break;

		case M_MEDIA_DESC_NOT_SUPTD:
			e = MEDIA_DESC_NOT_SUPTD;
			break;

		case M_MODEM_DESC_NOT_SUPTD:
			e = MODEM_DESC_NOT_SUPTD;
			break;

		case M_MUX_DESC_NOT_SUPTD:
			e = MUX_DESC_NOT_SUPTD;
			break;

		case M_EVENT_DESC_NOT_SUPTD:
			e = EVENT_DESC_NOT_SUPTD;
			break;

		case M_SIGNAL_DESC_NOT_SUPTD:
			e = SIGNAL_DESC_NOT_SUPTD;
			break;

		case M_DIGITMAP_DESC_NOT_SUPTD:
			e = DIGITMAP_DESC_NOT_SUPTD;
			break;

		case M_EVENTBUFF_DESC_NOT_SUPTD:
			e = EVENTBUFF_DESC_NOT_SUPTD;
			break;

		case M_AUDIT_DESC_NOT_SUPTD:
			e = AUDIT_DESC_NOT_SUPTD;
			break;

		case M_OBSRD_EVENT_DESC_NOT_SUPTD:
			e = OBSRD_EVENT_DESC_NOT_SUPTD;
			break;

		case M_STATS_DESC_NOT_SUPTD:
			e = STATS_DESC_NOT_SUPTD;
			break;

		case M_PCKG_DESC_NOT_SUPTD:
			e = PCKG_DESC_NOT_SUPTD;
			break;

		case M_SDPINFO_NOT_SUPTD:
			e = SDPINFO_NOT_SUPTD;
			break;

		case M_INV_PKG_ITEM_TYPE:
			e = INV_PKG_ITEM_TYPE;
			break;

		case M_INV_CTXID_TERMTYPE_PAIR:
			e = INV_CTXID_TERMTYPE_PAIR;
			break;

		case M_MISSING_LCL_TPT_ADDR:
			e = MISSING_LCL_TPT_ADDR;
			break;

		case M_MISSING_REMOTE_TPT_ADDR:
			e = MISSING_REMOTE_TPT_ADDR;
			break;

		case M_MISSING_SVC_CHNG_REASON:
			e = MISSING_SVC_CHNG_REASON;
			break;
		default:
			IllegalArgumentException illegalArgumentException = new IllegalArgumentException("No ErrorCode for passed value = " + value);
			throw illegalArgumentException;
		}
		return e;
	}

	private Object readResolve() {

		return this.getObject(this.error_code);

	}

	@Override
	public String toString() {
		String e = null;
		switch (this.error_code) {
		case M_MISSING_ENC_FORMAT:
			e = "ErrorCode[MISSING_ENC_FORMAT]";
			break;

		case M_TPT_ADDR_ALREADY_INUSE:
			e = "ErrorCode[TPT_ADDR_ALREADY_INUSE]";
			break;

		case M_PEER_ENTITY_UNVBLE:
			e = "ErrorCode[PEER_ENTITY_UNVBLE]";
			break;

		case M_INV_LOCAL_TPT_ADDRESS:
			e = "ErrorCode[INV_LOCAL_TPT_ADDRESS]";
			break;

		case M_INV_REMOTE_TPT_ADDRESS:
			e = "ErrorCode[INV_REMOTE_TPT_ADDRESS]";
			break;

		case M_INV_LCL_RMT_ADDR_PAIR:
			e = "ErrorCode[INV_LCL_RMT_ADDR_PAIR]";
			break;

		case M_INV_ASSOC_ID:
			e = "ErrorCode[INV_ASSOC_ID]";
			break;

		case M_MISSING_SVC_CHNG_METHOD:
			e = "ErrorCode[MISSING_SVC_CHNG_METHOD]";
			break;

		case M_INV_SVC_CHNG_METH_REASON_PAIR:
			e = "ErrorCode[INV_SVC_CHNG_METH_REASON_PAIR]";
			break;

		case M_UNSPTD_ENC_FORMAT:
			e = "ErrorCode[UNSPTD_ENC_FORMAT]";
			break;

		case M_UNSPTD_TPT_TYPE:
			e = "ErrorCode[UNSPTD_TPT_TYPE]";
			break;

		case M_INV_SVC_CHNG_ADDR:
			e = "ErrorCode[INV_SVC_CHNG_ADDR]";
			break;

		case M_INV_HOFF_MGCID:
			e = "ErrorCode[INV_HOFF_MGCID]";
			break;

		case M_UNSPTD_SVC_CHNG_METH_EXTN:
			e = "ErrorCode[UNSPTD_SVC_CHNG_METH_EXTN]";
			break;

		case M_INV_SVC_CHNG_REASON:
			e = "ErrorCode[INV_SVC_CHNG_REASON]";
			break;

		case M_INV_SVC_CHNG_METHOD:
			e = "ErrorCode[INV_SVC_CHNG_METHOD]";
			break;

		case M_RES_UNVBLE:
			e = "ErrorCode[RES_UNVBLE]";
			break;

		case M_MODIFY_ENC_FORMAT_FAILURE:
			e = "ErrorCode[MODIFY_ENC_FORMAT_FAILURE]";
			break;

		case M_MODIFY_TPT_TYPE_FAILURE:
			e = "ErrorCode[MODIFY_TPT_TYPE_FAILURE]";
			break;

		case M_MODIFY_SVC_PROFILE_FAILURE:
			e = "ErrorCode[MODIFY_SVC_PROFILE_FAILURE]";
			break;

		case M_MODIFY_PROTOCOL_VERSION_FAILURE:
			e = "ErrorCode[MODIFY_PROTOCOL_VERSION_FAILURE]";
			break;

		case M_INV_ACTION_HANDLE:
			e = "ErrorCode[INV_ACTION_HANDLE]";
			break;

		case M_WLDCRD_CMD_NOT_SUPTD:
			e = "ErrorCode[WLDCRD_CMD_NOT_SUPTD]";
			break;

		case M_INV_CMD_REQID:
			e = "ErrorCode[INV_CMD_REQID]";
			break;

		case M_INV_CMD_RESPID:
			e = "ErrorCode[INV_CMD_RESPID]";
			break;

		case M_TERM_TYPE_NOT_INSYNCH:
			e = "ErrorCode[TERM_TYPE_NOT_INSYNCH]";
			break;

		case M_INV_TERM_NAME_FORMAT:
			e = "ErrorCode[INV_TERM_NAME_FORMAT]";
			break;

		case M_TOPOLOGY_DESC_NOT_SUPTD:
			e = "ErrorCode[TOPOLOGY_DESC_NOT_SUPTD]";
			break;

		case M_MEDIA_DESC_NOT_SUPTD:
			e = "ErrorCode[MEDIA_DESC_NOT_SUPTD]";
			break;

		case M_MODEM_DESC_NOT_SUPTD:
			e = "ErrorCode[MODEM_DESC_NOT_SUPTD]";
			break;

		case M_MUX_DESC_NOT_SUPTD:
			e = "ErrorCode[MUX_DESC_NOT_SUPTD]";
			break;

		case M_EVENT_DESC_NOT_SUPTD:
			e = "ErrorCode[EVENT_DESC_NOT_SUPTD]";
			break;

		case M_SIGNAL_DESC_NOT_SUPTD:
			e = "ErrorCode[SIGNAL_DESC_NOT_SUPTD]";
			break;

		case M_DIGITMAP_DESC_NOT_SUPTD:
			e = "ErrorCode[DIGITMAP_DESC_NOT_SUPTD]";
			break;

		case M_EVENTBUFF_DESC_NOT_SUPTD:
			e = "ErrorCode[EVENTBUFF_DESC_NOT_SUPTD]";
			break;

		case M_AUDIT_DESC_NOT_SUPTD:
			e = "ErrorCode[AUDIT_DESC_NOT_SUPTD]";
			break;

		case M_OBSRD_EVENT_DESC_NOT_SUPTD:
			e = "ErrorCode[OBSRD_EVENT_DESC_NOT_SUPTD]";
			break;

		case M_STATS_DESC_NOT_SUPTD:
			e = "ErrorCode[STATS_DESC_NOT_SUPTD]";
			break;

		case M_PCKG_DESC_NOT_SUPTD:
			e = "ErrorCode[PCKG_DESC_NOT_SUPTD]";
			break;

		case M_SDPINFO_NOT_SUPTD:
			e = "ErrorCode[SDPINFO_NOT_SUPTD]";
			break;

		case M_INV_PKG_ITEM_TYPE:
			e = "ErrorCode[INV_PKG_ITEM_TYPE]";
			break;

		case M_INV_CTXID_TERMTYPE_PAIR:
			e = "ErrorCode[INV_CTXID_TERMTYPE_PAIR]";
			break;

		case M_MISSING_LCL_TPT_ADDR:
			e = "ErrorCode[MISSING_LCL_TPT_ADDR]";
			break;

		case M_MISSING_REMOTE_TPT_ADDR:
			e = "ErrorCode[MISSING_REMOTE_TPT_ADDR]";
			break;

		case M_MISSING_SVC_CHNG_REASON:
			e = "ErrorCode[MISSING_SVC_CHNG_REASON]";
			break;
		default:
			e = "ErrorCode[" + this.error_code + "]";
		}
		return e;
	}

}
Summary ✨

This Java class represents an error code for a signaling protocol, likely used in telecommunications. It defines various error codes and their corresponding descriptions, providing a way to identify and handle errors that may occur during communication. The class includes methods to get the error code as a string and its description, allowing for easy integration into other systems.
Tech Fingerprint

Standard IO/NIO
Alerts (46)

'=' Maintainability Info: Avoid using unnamed 'magic' numbers directly in comparisons or assignments. Use named constants (static final variables) instead to improve readability and maintainability.
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
'switch (' Ensure switch statements on enums or non-trivial types cover all cases or include a 'default:' label to handle unexpected values.
118 314