java/compiler/openapi/src/com/intellij/openapi/deployment/ContainerElement.java

   1 /*
   2  * Copyright 2000-2009 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 com.intellij.openapi.deployment;
  17
  18 import com.intellij.openapi.module.Module;
  19 import com.intellij.openapi.util.InvalidDataException;
  20 import com.intellij.openapi.util.JDOMExternalizable;
  21 import com.intellij.openapi.util.WriteExternalException;
  22 import org.jdom.Element;
  23 import org.jetbrains.annotations.NonNls;
  24 import org.jetbrains.annotations.NotNull;
  25
  26 import java.util.LinkedHashMap;
  27 import java.util.List;
  28 import java.util.Map;
  29
  30 public abstract class ContainerElement implements JDOMExternalizable, Cloneable, ResolvableElement {
  31   private final Map<String,String> myAttributes = new LinkedHashMap<String, String>();
  32   private final Module myParentModule;
  33   @NonNls public static final String URI_ATTRIBUTE = "URI";
  34   @NonNls public static final String PACKAGING_METHOD_ATTRIBUTE = "method";
  35   @NonNls public static final String ELEMENT_ATTRIBUTE = "attribute";
  36   @NonNls public static final String ATTRIBUTE_NAME = "name";
  37   @NonNls public static final String ATTRIBUTE_VALUE = "value";
  38
  39   protected ContainerElement(@NotNull Module parentModule) {
  40     myParentModule = parentModule;
  41   }
  42
  43   public abstract String getPresentableName();
  44
  45   public String getURI() {
  46     return getAttribute(URI_ATTRIBUTE);
  47   }
  48
  49   public void setURI(String uri) {
  50     setAttribute(URI_ATTRIBUTE, uri);
  51   }
  52   public PackagingMethod getPackagingMethod() {
  53     final String attribute = getAttribute(PACKAGING_METHOD_ATTRIBUTE);
  54     return attribute == null ? PackagingMethod.DO_NOT_PACKAGE : PackagingMethod.getDeploymentMethodById(attribute);
  55   }
  56   public void setPackagingMethod(PackagingMethod method) {
  57     setAttribute(PACKAGING_METHOD_ATTRIBUTE, method.getId());
  58   }
  59
  60   public void setAttribute(String name, String value) {
  61     myAttributes.put(name, value);
  62   }
  63   public String getAttribute(String name) {
  64     return myAttributes.get(name);
  65   }
  66
  67   @NotNull
  68   public Module getParentModule() {
  69     return myParentModule;
  70   }
  71
  72   public void readExternal(Element element) throws InvalidDataException {
  73     final List attrs = element.getChildren(ELEMENT_ATTRIBUTE);
  74     for (Object attr : attrs) {
  75       Element attribute = (Element)attr;
  76       final String name = attribute.getAttributeValue(ATTRIBUTE_NAME);
  77       final String value = attribute.getAttributeValue(ATTRIBUTE_VALUE);
  78       setAttribute(name, value);
  79     }
  80   }
  81
  82   public void writeExternal(Element element) throws WriteExternalException {
  83     for (Object o : myAttributes.keySet()) {
  84       String name = (String)o;
  85       String value = getAttribute(name);
  86       final Element attr = new Element(ELEMENT_ATTRIBUTE);
  87       attr.setAttribute(ATTRIBUTE_NAME, name);
  88       attr.setAttribute(ATTRIBUTE_VALUE, value == null ? "" : value);
  89       element.addContent(attr);
  90     }
  91   }
  92
  93   public abstract boolean equalsIgnoreAttributes(ContainerElement otherElement);
  94   public boolean equals(Object o) {
  95     if (this == o) return true;
  96     if (!(o instanceof ContainerElement)) return false;
  97
  98     final ContainerElement otherElement = (ContainerElement)o;
  99     if (!equalsIgnoreAttributes(otherElement)) return false;
 100     return myAttributes.equals(otherElement.myAttributes);
 101   }
 102
 103   public int hashCode() {
 104     return 0;
 105   }
 106
 107   public ContainerElement clone() {
 108     throw new UnsupportedOperationException();
 109   }
 110
 111 }