vpp/vpp-api/java/jvpp-registry/org/openvpp/jvpp/VppBaseCallException.java
Marek Gradzki 66ea26b1bc VPP-205: jvpp plugin support.
Splits jvpp into two jars
jvpp-registry.jar - base jvpp functionality
jvpp-core.jar - Java wrapper for vpe.api

Plugins can be generated the same way jvpp-core.jar is.
Example (nsh):
https://gerrit.fd.io/r/#/c/2118/

Change-Id: I2254f90b2c3e423563bb91bf70877979f1e90a7d
Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
2016-08-16 21:26:19 +00:00

61 lines
2.0 KiB
Java

/*
* Copyright (c) 2016 Cisco and/or its affiliates.
*
* 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 org.openvpp.jvpp;
/**
* Base exception representing failed operation of JVpp request call
*/
public abstract class VppBaseCallException extends Exception {
private final String methodName;
private final int errorCode;
/**
* Constructs an VppCallbackException with the specified api method name and error code.
*
* @param methodName name of a method, which invocation or execution failed
* @param errorCode negative error code value associated with this failure
* @throws NullPointerException if apiMethodName is null
*/
public VppBaseCallException(final String methodName, final int errorCode) {
super(String.format("vppApi.%s failed with error code: %d", methodName, errorCode));
this.methodName = java.util.Objects.requireNonNull(methodName, "apiMethodName is null!");
this.errorCode = errorCode;
if(errorCode >= 0) {
throw new IllegalArgumentException("Error code must be < 0. Was " + errorCode +
" for " + methodName );
}
}
/**
* Returns name of a method, which invocation failed.
*
* @return method name
*/
public String getMethodName() {
return methodName;
}
/**
* Returns the error code associated with this failure.
*
* @return a negative integer error code
*/
public int getErrorCode() {
return errorCode;
}
}