001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.jxpath;
019
020/**
021 * A delegate of {@link JXPathContext} that implements the XPath {@code "id()"} function. This delegate is only used when there is no default implementation of
022 * the {@code id()} function. For example, it is <em>not</em> used when the root of the context is a DOM Node.
023 */
024public interface IdentityManager {
025
026    /**
027     * Finds a node by its ID.
028     *
029     * @param context JXPathContext
030     * @param id      String
031     * @return Pointer
032     */
033    Pointer getPointerByID(JXPathContext context, String id);
034}