java/src/main/com/google/apphosting/utils/config/WebModule.java

   1 package com.google.apphosting.utils.config;
   2
   3 import com.google.common.base.StringUtil;
   4
   5 import java.io.File;
   6
   7 /**
   8  * Holder for information for a web module extracted from the module's
   9  * on disk application directory.
  10  *
  11  */
  12 public class WebModule {
  13   /**
  14    * Default value for a module name.
  15    */
  16   public static final String DEFAULT_MODULE_NAME = "default";
  17
  18   private final File applicationDirectory;
  19   private final AppEngineWebXml appEngineWebXml;
  20   private final File appEngineWebXmlFile;
  21   private final WebXml webXml;
  22   private final File webXmlFile;
  23   private final String contextRoot;
  24
  25   /**
  26    * Returns the server name specified in {@link #getAppEngineWebXml()} or
  27    * {@link #DEFAULT_SERVER_NAME} if none is specified.
  28    */
  29   public static String getModuleName(AppEngineWebXml appEngineWebXml) {
  30     return StringUtil.isEmptyOrWhitespace(appEngineWebXml.getModule()) ?
  31         "default" : appEngineWebXml.getModule().trim();
  32   }
  33
  34   WebModule(File applicationDirectory, AppEngineWebXml appEngineWebXml, File appEngineWebXmlFile,
  35       WebXml webXml, File webXmlFile,  String contextRoot) {
  36     this.applicationDirectory = applicationDirectory;
  37     this.appEngineWebXml = appEngineWebXml;
  38     this.appEngineWebXmlFile = appEngineWebXmlFile;
  39     this.webXml = webXml;
  40     this.webXmlFile = webXmlFile;
  41     this.contextRoot = contextRoot;
  42   }
  43
  44   public File getApplicationDirectory() {
  45     return applicationDirectory;
  46   }
  47
  48   public AppEngineWebXml getAppEngineWebXml() {
  49     return appEngineWebXml;
  50   }
  51
  52   public File getAppEngineWebXmlFile() {
  53     return appEngineWebXmlFile;
  54   }
  55
  56   public WebXml getWebXml() {
  57     return webXml;
  58   }
  59
  60   public File getWebXmlFile() {
  61     return webXmlFile;
  62   }
  63
  64   public String getContextRoot() {
  65     return contextRoot;
  66   }
  67
  68   /**
  69    * Returns the module name specified in {@link #getAppEngineWebXml()} or
  70    * {@link #DEFAULT_MODULE_NAME} if none is specified.
  71    */
  72   public String getModuleName() {
  73     return getModuleName(appEngineWebXml);
  74   }
  75
  76   @Override
  77   public int hashCode() {
  78     final int prime = 31;
  79     int result = 1;
  80     result = prime * result + ((appEngineWebXml == null) ? 0 : appEngineWebXml.hashCode());
  81     result = prime * result + ((appEngineWebXmlFile == null) ? 0 : appEngineWebXmlFile.hashCode());
  82     result =
  83         prime * result + ((applicationDirectory == null) ? 0 : applicationDirectory.hashCode());
  84     result = prime * result + ((contextRoot == null) ? 0 : contextRoot.hashCode());
  85     result = prime * result + ((webXml == null) ? 0 : webXml.hashCode());
  86     result = prime * result + ((webXmlFile == null) ? 0 : webXmlFile.hashCode());
  87     return result;
  88   }
  89
  90   @Override
  91   public boolean equals(Object obj) {
  92     if (this == obj) {
  93       return true;
  94     }
  95     if (obj == null) {
  96       return false;
  97     }
  98     if (getClass() != obj.getClass()) {
  99       return false;
 100     }
 101     WebModule other = (WebModule) obj;
 102     if (appEngineWebXml == null) {
 103       if (other.appEngineWebXml != null) {
 104         return false;
 105       }
 106     } else if (!appEngineWebXml.equals(other.appEngineWebXml)) {
 107       return false;
 108     }
 109     if (appEngineWebXmlFile == null) {
 110       if (other.appEngineWebXmlFile != null) {
 111         return false;
 112       }
 113     } else if (!appEngineWebXmlFile.equals(other.appEngineWebXmlFile)) {
 114       return false;
 115     }
 116     if (applicationDirectory == null) {
 117       if (other.applicationDirectory != null) {
 118         return false;
 119       }
 120     } else if (!applicationDirectory.equals(other.applicationDirectory)) {
 121       return false;
 122     }
 123     if (contextRoot == null) {
 124       if (other.contextRoot != null) {
 125         return false;
 126       }
 127     } else if (!contextRoot.equals(other.contextRoot)) {
 128       return false;
 129     }
 130     if (webXml == null) {
 131       if (other.webXml != null) {
 132         return false;
 133       }
 134     } else if (!webXml.equals(other.webXml)) {
 135       return false;
 136     }
 137     if (webXmlFile == null) {
 138       if (other.webXmlFile != null) {
 139         return false;
 140       }
 141     } else if (!webXmlFile.equals(other.webXmlFile)) {
 142       return false;
 143     }
 144     return true;
 145   }
 146
 147   @Override
 148   public String toString() {
 149     return "WebModule: applicationDirectory=" + applicationDirectory
 150         + " appEngineWebXml=" + appEngineWebXml
 151         + " appEngineWebXmlFile=" + appEngineWebXmlFile
 152         + " webXml=" + webXml
 153         + " webXmlFile=" + webXmlFile
 154         + " contextRoot=" + contextRoot;
 155   }
 156 }