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 */
017package org.apache.commons.jxpath;
018
019/**
020 * A delegate of {@link JXPathContext} that implements the XPath <code>"id()"</code>
021 * function. This delegate is only used when there is no default implementation
022 * of the <code>id()</code> function. For example, it is <i>not</i> used
023 * when the root of the context is a DOM Node.
024 *
025 * @author Dmitri Plotnikov
026 * @version $Revision: 652845 $ $Date: 2008-05-02 13:46:46 -0400 (Fri, 02 May 2008) $
027 */
028public interface IdentityManager {
029
030    /**
031     * Finds a node by its ID.
032     * @param context JXPathContext
033     * @param id String
034     * @return Pointer
035     */
036    Pointer getPointerByID(JXPathContext context, String id);
037}