xml/dom-openapi/src/com/intellij/util/xml/reflect/DomGenericInfo.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.util.xml.reflect;
  17
  18 import com.intellij.util.xml.DomElement;
  19 import com.intellij.util.xml.GenericDomValue;
  20 import com.intellij.psi.xml.XmlElement;
  21 import org.jetbrains.annotations.NonNls;
  22 import org.jetbrains.annotations.NotNull;
  23 import org.jetbrains.annotations.Nullable;
  24
  25 import java.util.List;
  26 import java.lang.reflect.Type;
  27
  28 /**
  29  * @author peter
  30  */
  31 public interface DomGenericInfo {
  32
  33   @Nullable
  34   String getElementName(DomElement element);
  35
  36   @NotNull
  37   List<? extends AbstractDomChildrenDescription> getChildrenDescriptions();
  38
  39   @NotNull
  40   List<? extends DomFixedChildDescription> getFixedChildrenDescriptions();
  41
  42   @NotNull
  43   List<? extends DomCollectionChildDescription> getCollectionChildrenDescriptions();
  44
  45   @NotNull
  46   List<? extends DomAttributeChildDescription> getAttributeChildrenDescriptions();
  47
  48   @Nullable DomFixedChildDescription getFixedChildDescription(@NonNls String tagName);
  49
  50   @Nullable DomFixedChildDescription getFixedChildDescription(@NonNls String tagName, @NonNls String namespaceKey);
  51
  52   @Nullable DomCollectionChildDescription getCollectionChildDescription(@NonNls String tagName);
  53
  54   @Nullable DomCollectionChildDescription getCollectionChildDescription(@NonNls String tagName, @NonNls String namespaceKey);
  55
  56   @Nullable
  57   DomAttributeChildDescription getAttributeChildDescription(@NonNls String attributeName);
  58
  59   @Nullable
  60   DomAttributeChildDescription getAttributeChildDescription(@NonNls String attributeName, @NonNls String namespaceKey);
  61
  62   Type[] getConcreteInterfaceVariants();
  63
  64   /**
  65    * @return true, if there's no children in the element, only tag value accessors
  66    */
  67   boolean isTagValueElement();
  68
  69   /**
  70    *
  71    * @param element
  72    * @return {@link com.intellij.psi.xml.XmlAttributeValue} or {@link com.intellij.psi.xml.XmlTag}
  73    */
  74   @Deprecated
  75   @Nullable
  76   XmlElement getNameElement(DomElement element);
  77
  78   @Nullable
  79   GenericDomValue getNameDomElement(DomElement element);
  80
  81   @Nullable
  82   CustomDomChildrenDescription getCustomNameChildrenDescription();
  83 }