org.jdesktop.swingx.IncidentInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of JMeasurement Show documentation
JMeasurement profiling programs in production enviroment
There is a newer version: 1.1.226
/*
 * $Id: IncidentInfo.java,v 1.2 2005/10/10 18:01:42 rbair Exp $
 *
 * Copyright 2004 Sun Microsystems, Inc., 4150 Network Circle,
 * Santa Clara, California 95054, U.S.A. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/

/**
 * This is abstract class that incapsulates all the information needed
 * to report a problem to the automated report/processing system.
 *
 * @author Alexander Zuev
 * @version 1.0
 */
package org.jdesktop.swingx;

public class IncidentInfo {
  /**
   * Short string that will be used as a error header
   */
  private String header;
  /**
   * Basic message that describes incident
   */
  private String basicErrorMessage;
  /**
   * Message that will fully describe the incident with all the
   * available details
   */
  private String detailedErrorMessage;
  /**
   * Optional Throwable that will be used
   */
  private Throwable errorException;

  /**
   * Main constructor that adds all the information to IncidentInfo
   * @param header
   * @param basicErrorMessage
   * @param detailedErrorMesage
   * @param errorException
   */
  public IncidentInfo(String header, String basicErrorMessage, String detailedErrorMesage, Throwable errorException) {
    this.header = header;
    if (basicErrorMessage != null) {
      this.basicErrorMessage = basicErrorMessage;
    } else {
      if (errorException != null) {
        this.basicErrorMessage = errorException.getLocalizedMessage();
      } else {
        this.basicErrorMessage = "";
      }
    }
    this.detailedErrorMessage = detailedErrorMesage;
    this.errorException = errorException;
  }

  public IncidentInfo(String header, String basicErrorMessage, String detailedErrorMessage) {
    this(header, basicErrorMessage, detailedErrorMessage, null);
  }

  public IncidentInfo(String header, Throwable errorException) {
    this(header, null, null, errorException);
  }

  /**
   * Get the current header string
   *
   * @return header string
   */
  public String getHeader() {
    return header;
  }

  /**
   * Set the current header string
   *
   * @param header
   */
  public void setHeader(String header) {
    this.header = header;
  }

  /**
   * Get the basic error description
   *
   * @return basic error description
   */
  public String getBasicErrorMessage() {
    return basicErrorMessage;
  }

  /**
   * Set the current basic error description
   *
   * @param basicErrorMessage
   */
  public void setBasicErrorMessage(String basicErrorMessage) {
    this.basicErrorMessage = basicErrorMessage;
  }

  /**
   * Get the detailed error description
   *
   * @return detailed description
   */
  public String getDetailedErrorMessage() {
    return detailedErrorMessage;
  }

  /**
   * Set the detailed description for this error
   *
   * @param detailedErrorMessage
   */
  public void setDetailedErrorMessage(String detailedErrorMessage) {
    this.detailedErrorMessage = detailedErrorMessage;
  }

  /**
   * Get an exception that contains some additional information about the
   * error if provided.
   *
   * @return exception or null if no exception provided
   */
  public Throwable getErrorException() {
    return errorException;
  }

  /**
   * Set the exception that may contain additional information about the
   * error.
   *
   * @param errorException
   */
  public void setErrorException(Throwable errorException) {
    this.errorException = errorException;
  }
}