Adding interfaces in documentation
[aai/sparky-be.git] / sparkybe-onap-service / src / main / java / org / onap / aai / sparky / util / ErrorUtil.java
1 /**
2  * ============LICENSE_START===================================================
3  * SPARKY (AAI UI service)
4  * ============================================================================
5  * Copyright © 2017 AT&T Intellectual Property.
6  * Copyright © 2017 Amdocs
7  * All rights reserved.
8  * ============================================================================
9  * Licensed under the Apache License, Version 2.0 (the "License");
10  * you may not use this file except in compliance with the License.
11  * You may obtain a copy of the License at
12  *
13  *      http://www.apache.org/licenses/LICENSE-2.0
14  *
15  * Unless required by applicable law or agreed to in writing, software
16  * distributed under the License is distributed on an "AS IS" BASIS,
17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18  * See the License for the specific language governing permissions and
19  * limitations under the License.
20  * ============LICENSE_END=====================================================
21  *
22  * ECOMP and OpenECOMP are trademarks
23  * and service marks of AT&T Intellectual Property.
24  */
25 package org.onap.aai.sparky.util;
26
27 /**
28  * The Class ErrorUtil.
29  */
30 public class ErrorUtil {
31
32   /**
33    * Extract stack trace elements.
34    *
35    * @param maxNumberOfElementsToCapture the max number of elements to capture
36    * @param exc the exc
37    * @return the string
38    */
39   public static String extractStackTraceElements(int maxNumberOfElementsToCapture, Exception exc) {
40     StringBuilder sb = new StringBuilder(128);
41
42     StackTraceElement[] stackTraceElements = exc.getStackTrace();
43
44     if (stackTraceElements != null) {
45
46       /*
47        * We want to avoid an index out-of-bounds error, so we will make sure to only extract the
48        * number of frames from the stack trace that actually exist.
49        */
50
51       int numFramesToExtract = Math.min(maxNumberOfElementsToCapture, stackTraceElements.length);
52
53       for (int x = 0; x < numFramesToExtract; x++) {
54         sb.append(stackTraceElements[x]).append("\n");
55       }
56
57     }
58
59     return sb.toString();
60   }
61 }