1 /* 2 * Portions of this software was developed by employees of the National Institute 3 * of Standards and Technology (NIST), an agency of the Federal Government and is 4 * being made available as a public service. Pursuant to title 17 United States 5 * Code Section 105, works of NIST employees are not subject to copyright 6 * protection in the United States. This software may be subject to foreign 7 * copyright. Permission in the United States and in foreign countries, to the 8 * extent that NIST may hold copyright, to use, copy, modify, create derivative 9 * works, and distribute this software and its documentation without fee is hereby 10 * granted on a non-exclusive basis, provided that this notice and disclaimer 11 * of warranty appears in all copies. 12 * 13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 25 */ 26 27 package gov.nist.secauto.metaschema.core.metapath; 28 29 /** 30 * This Metapath exception base class is used for all exceptions that have a 31 * defined error code family and value. 32 */ 33 public abstract class AbstractCodedMetapathException 34 extends MetapathException { 35 36 /** 37 * the serial version UID. 38 */ 39 private static final long serialVersionUID = 1L; 40 41 /** 42 * The error code. 43 */ 44 private final int code; 45 46 /** 47 * Constructs a new Metapath exception with the provided {@code message} and no 48 * cause. 49 * 50 * @param code 51 * the error code value 52 * @param message 53 * the exception message 54 */ 55 public AbstractCodedMetapathException(int code, String message) { 56 super(message); 57 this.code = code; 58 } 59 60 /** 61 * Constructs a new Metapath exception with the provided {@code message} and 62 * {@code cause}. 63 * 64 * @param code 65 * the error code value 66 * @param message 67 * the exception message 68 * @param cause 69 * the exception cause 70 */ 71 public AbstractCodedMetapathException(int code, String message, Throwable cause) { 72 super(message, cause); 73 this.code = code; 74 } 75 76 /** 77 * Constructs a new Metapath exception with a {@code null} message and the 78 * provided {@code cause}. 79 * 80 * @param code 81 * the error code value 82 * @param cause 83 * the exception cause 84 */ 85 public AbstractCodedMetapathException(int code, Throwable cause) { 86 super(cause); 87 this.code = code; 88 } 89 90 @Override 91 public String getMessage() { 92 return String.format("%s: %s", getCodeAsString(), super.getMessage()); 93 } 94 95 /** 96 * Get the error code value. 97 * 98 * @return the error code value 99 */ 100 protected int getCode() { 101 return code; 102 } 103 104 /** 105 * Get the error code family. 106 * 107 * @return the error code family 108 */ 109 protected abstract String getCodePrefix(); 110 111 /** 112 * Get a combination of the error code family and value. 113 * 114 * @return the full error code. 115 */ 116 protected String getCodeAsString() { 117 return String.format("%s%04d", getCodePrefix(), getCode()); 118 } 119 }