src/main/gov/nasa/jpf/util/Result.java

   1 /*
   2  * Copyright (C) 2014, United States Government, as represented by the
   3  * Administrator of the National Aeronautics and Space Administration.
   4  * All rights reserved.
   5  *
   6  * The Java Pathfinder core (jpf-core) platform is licensed under the
   7  * Apache License, Version 2.0 (the "License"); you may not use this file except
   8  * in compliance with the License. You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0.
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 package gov.nasa.jpf.util;
  19
  20 /**
  21  * simple result wrapper that can store a boolean value and a String, to
  22  * be used as method return value if we have to keep exceptions in the callee
  23  */
  24 public class Result {
  25
  26   public static final Result OK = new Result();
  27
  28   // final so that we don't need getters
  29   public final String error;
  30
  31   // if you need a positive result, use OK
  32   private Result (){
  33     error = null;
  34   }
  35
  36   private Result (String errorMsg){
  37     error = errorMsg;
  38   }
  39
  40   @Override
  41   public boolean equals(Object o){
  42     // we only compare if there was an error, not which one
  43     if (o instanceof Boolean){
  44       return (error == null) == (Boolean)o;
  45     } else if (o instanceof Result){
  46       return (error == null) == (((Result)o).error == null);
  47     }
  48     return false;
  49   }
  50
  51   public static Result failure (String errorMsg){
  52     return new Result(errorMsg);
  53   }
  54 }