Commons JXPath example source code file (KeyManager.java)

This example Commons JXPath source code file (KeyManager.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Commons JXPath tags/keywords

jxpathcontext, jxpathcontext, keymanager, keymanager, pointer, pointer, string, string

The Commons JXPath KeyManager.java source code

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.jxpath;

/**
 * A delegate of {@link JXPathContext} that implements the XPath <code>"key()"
 * function.
 *
 * @author Dmitri Plotnikov
 * @version $Revision: 652845 $ $Date: 2008-05-02 12:46:46 -0500 (Fri, 02 May 2008) $
 */
public interface KeyManager {

    /**
     * Find a node by key/value.
     *
     * @param context to search
     * @param keyName String
     * @param keyValue String
     * @return Pointer
     */
    Pointer getPointerByKey(
        JXPathContext context,
        String keyName,
        String keyValue);
}