java/src/main/com/google/appengine/api/conversion/ConversionResult.java

   1 // Copyright 2011 Google Inc. All Rights Reserved.
   2
   3 package com.google.appengine.api.conversion;
   4
   5 import com.google.common.base.Objects;
   6 import com.google.common.base.Preconditions;
   7
   8 /**
   9  * A single immutable conversion result returned by the conversion service.
  10  *
  11  */
  12 public final class ConversionResult {
  13  private final ConversionErrorCode errorCode; private final Document output;
  14
  15   /**
  16    * Constructs a conversion result when the conversion failed.
  17    *
  18    * @param errorCode the conversion error code
  19    */
  20   ConversionResult(ConversionErrorCode errorCode) {
  21     this.errorCode = Preconditions.checkNotNull(errorCode);
  22     this.output = null;
  23   }
  24
  25   /**
  26    * Constructs a conversion result when the conversion succeeded.
  27    *
  28    * @param output the output document
  29    */
  30   ConversionResult(Document output) {
  31     this.errorCode = null;
  32     this.output = Preconditions.checkNotNull(output);
  33   }
  34
  35   /**
  36    * Returns whether the conversion succeeded.
  37    */
  38   public boolean success() {
  39     return output != null;
  40   }
  41
  42   /**
  43    * Returns the conversion error code, or null if the conversion succeeded.
  44    */
  45   public ConversionErrorCode getErrorCode() {
  46     return errorCode;
  47   }
  48
  49   /**
  50    * Returns the conversion output document, or null if the conversion failed.
  51    */
  52   public Document getOutputDoc() {
  53     return output;
  54   }
  55
  56   @Override
  57   public boolean equals(Object o) {
  58     if (this == o) {
  59       return true;
  60     }
  61     if (o == null || getClass() != o.getClass()) {
  62       return false;
  63     }
  64
  65     ConversionResult other = (ConversionResult) o;
  66     return Objects.equal(errorCode, other.getErrorCode())
  67            && Objects.equal(output, other.getOutputDoc());
  68   }
  69
  70   @Override
  71   public int hashCode() {
  72     return Objects.hashCode(errorCode, output);
  73   }
  74 }