java/src/main/com/google/appengine/api/files/FileStat.java

   1 // Copyright 2012 Google Inc. All Rights Reserved.
   2
   3 package com.google.appengine.api.files;
   4
   5 import static java.lang.String.format;
   6
   7 /**
   8  * A {@link FileStat} contains information about a single file.
   9  *
  10  */
  11 public final class FileStat {
  12
  13   private String filename;
  14   private boolean finalized;
  15   private Long length;
  16   private Long ctime;
  17   private Long mtime;
  18
  19   @Override
  20   public boolean equals(Object obj) {
  21     if (obj instanceof FileStat) {
  22       return filename.equals(((FileStat) obj).filename);
  23     }
  24     return false;
  25   }
  26
  27   @Override
  28   public int hashCode() {
  29     return filename.hashCode();
  30   }
  31
  32   @Override
  33   public String toString() {
  34     return format("FileStat for %s: length %d, ctime %d, mtime %d, finalized %b.",
  35         filename, length, ctime, mtime, finalized);
  36   }
  37
  38   /**
  39    * @param filename the uploaded filename of the file.
  40    */
  41   public void setFilename(String filename) {
  42     this.filename = filename;
  43   }
  44
  45   /**
  46    * @param finalized whether the file is finalized.
  47    */
  48   public void setFinalized(boolean finalized) {
  49     this.finalized = finalized;
  50   }
  51
  52   /**
  53    * @param length the number of bytes of the file.
  54    */
  55   public void setLength(long length) {
  56     this.length = length;
  57   }
  58
  59   /**
  60    * @param ctime creation time.
  61    */
  62   public void setCtime(long ctime) {
  63     this.ctime = ctime;
  64   }
  65
  66   /**
  67    * @param mtime modification time.
  68    */
  69   public void setMtime(long mtime) {
  70     this.mtime = mtime;
  71   }
  72
  73   /**
  74    * @return the filename.
  75    */
  76   public String getFilename() {
  77     return filename;
  78   }
  79
  80   /**
  81    * @return whether or not the file is finalized
  82    */
  83   public boolean isFinalized() {
  84     return finalized;
  85   }
  86
  87   /**
  88    * @return the length. {@code null} if not set.
  89    */
  90   public Long getLength() {
  91     return length;
  92   }
  93
  94   /**
  95    * This field is never set under current implementation.
  96    *
  97    * @return the ctime. {@code null} if not set.
  98    */
  99   public Long getCtime() {
 100     return ctime;
 101   }
 102
 103   /**
 104    * This field is never set under current implementation.
 105    *
 106    * @return the mtime. {@code null} if not set.
 107    */
 108   public Long getMtime() {
 109     return mtime;
 110   }
 111 }