2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.yangtools.yang.data.api.schema.xpath;
10 import org.eclipse.jdt.annotation.NonNullByDefault;
11 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
14 * A factory for obtaining {@link XPathSchemaContext}s. This is the primary entry point to an XPath evaluation
15 * implementation. Users are expected to resolve these via their service resolution framework, be it
16 * {@link java.util.ServiceLoader}, OSGi or similar.
19 * Implementations are required to support {@link java.util.ServiceLoader}.
22 public interface XPathSchemaContextFactory {
24 * Create an {@link XPathSchemaContext} based on a {@link SchemaContext}. This effectively binds the namespaces
25 * the user expects to map to YANG schema. The {@link XPathExpression} compilation, relocation and optimization
26 * processes can take advantage of the YANG schema provided.
28 * @param context SchemaContext associated with the resulting {@link XPathSchemaContext}
29 * @return An {@link XPathSchemaContext} instance
31 XPathSchemaContext createContext(SchemaContext context);