RevisionAwareXPath.java

/*
 * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.yang.model.api;

/**
 * Contains methods for getting data (concrete XPath) and metadata (is XPath
 * absolute) from XPath instance.
 */
public interface RevisionAwareXPath {

    /**
     * Returns <code>true</code> if the XPapth starts in root of Yang model,
     * otherwise returns <code>false</code>.
     *
     * @return <code>true</code> if the XPapth starts in root of Yang model,
     *         otherwise returns <code>false</code>
     */
    boolean isAbsolute();

    /**
     * Returns the XPath formatted string as is defined in model. <br>
     * For example:
     * /prefix:container/prefix:container::cond[when()=foo]/prefix:leaf
     *
     * @return the XPath formatted string as is defined in model.
     */
    @Override
    String toString();
}