View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.jxpath;
19  
20  /**
21   * A delegate of {@link JXPathContext} that implements the XPath {@code "id()"} function. This delegate is only used when there is no default implementation of
22   * the {@code id()} function. For example, it is <em>not</em> used when the root of the context is a DOM Node.
23   */
24  public interface IdentityManager {
25  
26      /**
27       * Finds a node by its ID.
28       *
29       * @param context JXPathContext
30       * @param id      String
31       * @return Pointer
32       */
33      Pointer getPointerByID(JXPathContext context, String id);
34  }