tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/analysis/ondemand/OnDemandAnalysisException.java

   1 /*******************************************************************************
   2  * Copyright (c) 2016 EfficiOS Inc., Alexandre Montplaisir
   3  *
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *******************************************************************************/
   9
  10 package org.eclipse.tracecompass.tmf.core.analysis.ondemand;
  11
  12 import org.eclipse.jdt.annotation.Nullable;
  13
  14 /**
  15  * Exceptions resulting from the execution of on-demand analyses.
  16  *
  17  * The suggested behavior is to display the reported messages to the end user,
  18  * so they know why execution did not end normally.
  19  *
  20  * @author Alexandre Montplaisir
  21  * @since 2.0
  22  */
  23 public class OnDemandAnalysisException extends Exception {
  24
  25     private static final long serialVersionUID = 7296987172562152876L;
  26
  27     /**
  28      * Build a new exception. If the message is not null, it should be reported
  29      * to the user.
  30      *
  31      * @param message
  32      *            The message to display, if any
  33      */
  34     public OnDemandAnalysisException(@Nullable String message) {
  35         super(message);
  36     }
  37
  38     @Override
  39     public @Nullable String getMessage() {
  40         return super.getMessage();
  41     }
  42
  43 }