Repair Doxygen build infrastructure
[vpp.git] / src / vpp-api / java / jvpp-registry / io / fd / vpp / jvpp / VppCallbackException.java
1 /*
2  * Copyright (c) 2016 Cisco and/or its affiliates.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package io.fd.vpp.jvpp;
18
19 /**
20  * Callback Exception representing failed operation of JVpp request call
21  */
22 public class VppCallbackException extends VppBaseCallException {
23     private final int ctxId;
24
25     /**
26      * Constructs an VppCallbackException with the specified api method name and error code.
27      *
28      * @param methodName  name of a method, which invocation failed.
29      * @param ctxId      api request context identifier
30      * @param errorCode  negative error code value associated with this failure
31      * @throws NullPointerException     if apiMethodName is null
32      */
33     public VppCallbackException(final String methodName, final int ctxId, final int errorCode ){
34         super(methodName, errorCode);
35         this.ctxId = ctxId;
36     }
37
38     /**
39      * Returns api request context identifier.
40      *
41      * @return value of context identifier
42      */
43     public int getCtxId() {
44         return ctxId;
45     }
46
47 }