cleanup: remove useless '@author nik' from javadoc comments
[idea/community.git] / jps / antLayout / src / jetbrains / antlayout / datatypes / IdeaModuleBase.java
1 /*
2  * Copyright 2000-2012 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package jetbrains.antlayout.datatypes;
17
18 import jetbrains.antlayout.util.LayoutFileSet;
19 import org.apache.tools.ant.BuildException;
20 import org.apache.tools.ant.types.ZipFileSet;
21
22 import java.io.File;
23
24 public abstract class IdeaModuleBase extends LayoutFileSet {
25   private String name;
26
27   protected IdeaModuleBase() {
28     setExcludes("classpath.index");
29   }
30
31   public IdeaModuleBase(ZipFileSet fileset) {
32     super(fileset);
33   }
34
35   public String getName() {
36     return name;
37   }
38
39   public void setName(String name) {
40     this.name = name;
41     setDir(getOutputDir());
42   }
43
44   protected File getOutputDir() {
45     String adhoc = getProject().getProperty(getOutputDirProperty());
46     return adhoc != null ? new File(adhoc) : null;
47   }
48
49   public void validateArguments() throws BuildException {
50     if (name == null) {
51       throw new BuildException("name attribute must be specified for module entry");
52     }
53
54     File outputDir = getOutputDir();
55     if (outputDir == null) {
56       throw new BuildException("Cannot find " + getKind() + " output for module " + name + ": '" + getOutputDirProperty() + "' property isn't defined");
57     }
58     if (!outputDir.exists()) {
59       throw new BuildException("No " + getKind() + " output found for module " + name + ": " + outputDir + " doesn't exist");
60     }
61   }
62
63   protected abstract String getOutputDirProperty();
64
65   protected abstract String getKind();
66
67   public boolean equals(Object o) {
68     if (this == o) return true;
69     if (o == null || getClass() != o.getClass()) return false;
70
71     IdeaModule that = (IdeaModule) o;
72     return getDir(getProject()).equals(that.getDir(getProject()));
73   }
74
75   public int hashCode() {
76     return getDir(getProject()).hashCode();
77   }
78 }