001/*
002 * Portions of this software was developed by employees of the National Institute
003 * of Standards and Technology (NIST), an agency of the Federal Government and is
004 * being made available as a public service. Pursuant to title 17 United States
005 * Code Section 105, works of NIST employees are not subject to copyright
006 * protection in the United States. This software may be subject to foreign
007 * copyright. Permission in the United States and in foreign countries, to the
008 * extent that NIST may hold copyright, to use, copy, modify, create derivative
009 * works, and distribute this software and its documentation without fee is hereby
010 * granted on a non-exclusive basis, provided that this notice and disclaimer
011 * of warranty appears in all copies.
012 *
013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
025 */
026
027package gov.nist.secauto.metaschema.core.metapath;
028
029/**
030 * This Metapath exception base class is used for all exceptions that have a
031 * defined error code family and value.
032 */
033public abstract class AbstractCodedMetapathException
034    extends MetapathException {
035
036  /**
037   * the serial version UID.
038   */
039  private static final long serialVersionUID = 1L;
040
041  /**
042   * The error code.
043   */
044  private final int code;
045
046  /**
047   * Constructs a new Metapath exception with the provided {@code message} and no
048   * cause.
049   *
050   * @param code
051   *          the error code value
052   * @param message
053   *          the exception message
054   */
055  public AbstractCodedMetapathException(int code, String message) {
056    super(message);
057    this.code = code;
058  }
059
060  /**
061   * Constructs a new Metapath exception with the provided {@code message} and
062   * {@code cause}.
063   *
064   * @param code
065   *          the error code value
066   * @param message
067   *          the exception message
068   * @param cause
069   *          the exception cause
070   */
071  public AbstractCodedMetapathException(int code, String message, Throwable cause) {
072    super(message, cause);
073    this.code = code;
074  }
075
076  /**
077   * Constructs a new Metapath exception with a {@code null} message and the
078   * provided {@code cause}.
079   *
080   * @param code
081   *          the error code value
082   * @param cause
083   *          the exception cause
084   */
085  public AbstractCodedMetapathException(int code, Throwable cause) {
086    super(cause);
087    this.code = code;
088  }
089
090  @Override
091  public String getMessage() {
092    return String.format("%s: %s", getCodeAsString(), super.getMessage());
093  }
094
095  /**
096   * Get the error code value.
097   *
098   * @return the error code value
099   */
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}