attic/yang-data-jaxen/src/main/java/org/opendaylight/yangtools/yang/data/jaxen/api/RelocatableXPathExpression.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.yang.data.jaxen.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import org.eclipse.jdt.annotation.NonNull;
  12 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  13
  14 /**
  15  * Interface implemented by {@link XPathExpression}s which can be recompiled to execute more efficiently at a
  16  * at a different {@link SchemaPath} than they were originally compiled at. This can result in the expression being
  17  * moved either up or down in a SchemaPath tree, usually closer to their {@link #getApexPath()}.
  18  */
  19 @Beta
  20 @Deprecated
  21 public interface RelocatableXPathExpression extends XPathExpression {
  22     /**
  23      * Return a new XPathExpression relocated to a SchemaPath of the implementation's choosing. Note that
  24      * {@link #getApexPath()} must not change during this operation.
  25      *
  26      * @return A new XPathExpression instance.
  27      */
  28     @NonNull XPathExpression relocateExpression();
  29 }