java/src/main/com/google/appengine/api/conversion/Conversion.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 from one file format to another.
  10  *
  11  */
  12 public final class Conversion {
  13
  14   private final Document input;
  15   private final String outputMimeType;
  16   private final ConversionOptions options;
  17
  18   /**
  19    * Constructs a conversion with default options.
  20    *
  21    * @param input the input document
  22    * @param outputMimeType the output mime type
  23    * @throws IllegalArgumentException if the input document is invalid for
  24    *         conversion
  25    */
  26   public Conversion(Document input, String outputMimeType) {
  27     this(input, outputMimeType, ConversionOptions.Builder.withDefaults());
  28   }
  29
  30   /**
  31    * Constructs a conversion with specified options.
  32    *
  33    * @param input the input document
  34    * @param outputMimeType the output mime type
  35    * @param options the conversion options setting
  36    */
  37   public Conversion(Document input, String outputMimeType, ConversionOptions options) {
  38     this.input = Preconditions.checkNotNull(input);
  39     this.outputMimeType = Preconditions.checkNotNull(outputMimeType).toLowerCase();
  40     this.options = Preconditions.checkNotNull(options);
  41   }
  42
  43   /**
  44    * Returns the conversion input document.
  45    */
  46   public Document getInputDoc() {
  47     return input;
  48   }
  49
  50   /**
  51    * Returns the conversion output mime type.
  52    */
  53   public String getOutputMimeType() {
  54     return outputMimeType;
  55   }
  56
  57   /**
  58    * Returns the conversion options setting.
  59    */
  60   public ConversionOptions getOptions() {
  61     return options;
  62   }
  63
  64   @Override
  65   public boolean equals(Object o) {
  66     if (this == o) {
  67       return true;
  68     }
  69     if (o == null || getClass() != o.getClass()) {
  70       return false;
  71     }
  72
  73     Conversion other = (Conversion) o;
  74     return Objects.equal(input, other.getInputDoc())
  75            && Objects.equal(outputMimeType, other.getOutputMimeType())
  76            && Objects.equal(options, other.getOptions());
  77   }
  78
  79   @Override
  80   public int hashCode() {
  81     return Objects.hashCode(input, outputMimeType, options);
  82   }
  83 }