xml/dom-openapi/src/com/intellij/util/xml/ScopeProvider.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;
  17
  18 import org.jetbrains.annotations.NotNull;
  19 import org.jetbrains.annotations.Nullable;
  20
  21 /**
  22  * Should be stateless, since its instances are cached.
  23  * @author peter
  24  * @see Scope
  25  */
  26 public abstract class ScopeProvider {
  27
  28   /**
  29    * @param element element
  30    * @return scope to search within.
  31    * For uniqueness checking should return element, whose direct children names will be compared.
  32    * Basically it's parameter element's parent: {@link ParentScopeProvider}.
  33    * Searches within all children of returned element.
  34    */
  35   @Nullable
  36   public abstract DomElement getScope(@NotNull DomElement element);
  37
  38 }