yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/RevisionAwareXPath.java

   1 /*
   2  * Copyright (c) 2013 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.model.api;
   9
  10 /**
  11  * Contains methods for getting data (concrete XPath) and metadata (is XPath
  12  * absolute) from XPath instance.
  13  */
  14 public interface RevisionAwareXPath {
  15
  16     /**
  17      * Returns <code>true</code> if the XPapth starts in root of Yang model,
  18      * otherwise returns <code>false</code>.
  19      *
  20      * @return <code>true</code> if the XPapth starts in root of Yang model,
  21      *         otherwise returns <code>false</code>
  22      */
  23     boolean isAbsolute();
  24
  25     /**
  26      * Returns the XPath formatted string as is defined in model. <br>
  27      * For example:
  28      * /prefix:container/prefix:container::cond[when()=foo]/prefix:leaf
  29      *
  30      * @return the XPath formatted string as is defined in model.
  31      */
  32     @Override
  33     String toString();
  34 }