caliper/src/main/java/com/google/caliper/UserException.java

/*
 * Copyright (C) 2009 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.caliper;

import java.util.Arrays;
import java.util.Set;

/**
 * Signifies a problem that should be explained in user-friendly terms on the command line, without
 * a confusing stack trace, and optionally followed by a usage summary.
 */
@SuppressWarnings("serial") // never going to serialize these... right?
public abstract class UserException extends RuntimeException {
  protected UserException(String error) {
    super(error);
  }

  public abstract void display();

  // - - - -

  public abstract static class ErrorInUsageException extends UserException {
    protected ErrorInUsageException(String error) {
      super(error);
    }

    @Override public void display() {
      String message = getMessage();
      if (message != null) {
        System.err.println("Error: " + message);
      }
      Arguments.printUsage();
    }
  }

  public abstract static class ErrorInUserCodeException extends UserException {
    private final String remedy;

    protected ErrorInUserCodeException(String error, String remedy) {
      super(error);
      this.remedy = remedy;
    }

    @Override public void display() {
      System.err.println("Error: " + getMessage());
      System.err.println("Typical Remedy: " + remedy);
    }
  }

  // - - - -

  // Not technically an error, but works nicely this way anyway
  public static class DisplayUsageException extends ErrorInUsageException {
    public DisplayUsageException() {
      super(null);
    }
  }

  public static class IncompatibleArgumentsException extends ErrorInUsageException {
    public IncompatibleArgumentsException(String arg) {
      super("Some arguments passed in are incompatible with: " + arg);
    }
  }

  public static class UnrecognizedOptionException extends ErrorInUsageException {
    public UnrecognizedOptionException(String arg) {
      super("Argument not recognized: " + arg);
    }
  }

  public static class NoBenchmarkClassException extends ErrorInUsageException {
    public NoBenchmarkClassException() {
      super("No benchmark class specified.");
    }
  }

  public static class MultipleBenchmarkClassesException extends ErrorInUsageException {
    public MultipleBenchmarkClassesException(String a, String b) {
      super("Multiple benchmark classes specified: " + Arrays.asList(a, b));
    }
  }

  public static class MalformedParameterException extends ErrorInUsageException {
    public MalformedParameterException(String arg) {
      super("Malformed parameter: " + arg);
    }
  }

  public static class DuplicateParameterException extends ErrorInUsageException {
    public DuplicateParameterException(String arg) {
      super("Duplicate parameter: " + arg);
    }
    public DuplicateParameterException(Set<String> arg) {
      super("Duplicate parameters: " + arg);
    }
  }

  public static class InvalidParameterValueException extends ErrorInUsageException {
    public InvalidParameterValueException(String arg, String value) {
      super("Invalid value \"" + value + "\" for parameter: " + arg);
    }
  }

  public static class InvalidTrialsException extends ErrorInUsageException {
    public InvalidTrialsException(String arg) {
      super("Invalid trials: " + arg);
    }
  }

  public static class CantCustomizeInProcessVmException extends ErrorInUsageException {
    public CantCustomizeInProcessVmException() {
      super("Can't customize VM when running in process.");
    }
  }

  public static class NoSuchClassException extends ErrorInUsageException {
    public NoSuchClassException(String name) {
      super("No class named [" + name + "] was found (check CLASSPATH).");
    }
  }

  public static class RuntimeOutOfRangeException extends ErrorInUsageException {
    public RuntimeOutOfRangeException(
        double nanosPerExecution, double lowerBound, double upperBound) {
      super("Runtime " + nanosPerExecution + "ns/rep out of range "
          + lowerBound + "-" + upperBound);
    }
  }

  public static class DoesNotScaleLinearlyException extends ErrorInUsageException {
    public DoesNotScaleLinearlyException() {
      super("Doing 2x as much work didn't take 2x as much time! "
          + "Is the JIT optimizing away the body of your benchmark?");
    }
  }

  public static class NonConstantMemoryUsage extends ErrorInUsageException {
    public NonConstantMemoryUsage() {
      super("Not all reps of the inner loop allocate the same number of times! "
          + "The reps loop should use a constant number of allocations. "
          + "Are you using the value of reps inside the loop?");
    }
  }

  public static class AbstractBenchmarkException extends ErrorInUserCodeException {
    public AbstractBenchmarkException(Class<?> specifiedClass) {
      super("Class [" + specifiedClass.getName() + "] is abstract.", "Specify a concrete class.");
    }
  }

  public static class NoParameterlessConstructorException extends ErrorInUserCodeException {
    public NoParameterlessConstructorException(Class<?> specifiedClass) {
      super("Class [" + specifiedClass.getName() + "] has no parameterless constructor.",
          "Remove all constructors or add a parameterless constructor.");
    }
  }

  public static class DoesntImplementBenchmarkException extends ErrorInUserCodeException {
    public DoesntImplementBenchmarkException(Class<?> specifiedClass) {
      super("Class [" + specifiedClass + "] does not implement the " + Benchmark.class.getName()
          + " interface.", "Add 'extends " + SimpleBenchmark.class + "' to the class declaration.");
    }
  }

  public static class InvalidDebugRepsException extends ErrorInUsageException {
    public InvalidDebugRepsException(String arg) {
      super("Invalid debug reps: " + arg);
    }
  }

  // TODO: should remove the caliper stack frames....
  public static class ExceptionFromUserCodeException extends UserException {
    public ExceptionFromUserCodeException(Throwable t) {
      super("An exception was thrown from the benchmark code.");
      initCause(t);
    }
    @Override public void display() {
      System.err.println(getMessage());
      getCause().printStackTrace(System.err);
    }
  }
}