yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/InstanceIdentifierTypeDefinition.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.type;
   9
  10 import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
  11 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  12
  13 /**
  14  * Contains methods for getting data from the <code>instance-identifier</code>
  15  * YANG built-in type.
  16  */
  17 public interface InstanceIdentifierTypeDefinition extends TypeDefinition<InstanceIdentifierTypeDefinition> {
  18
  19     /**
  20      * Returns XPath for instance of <code>InstanceIdentifierTypeDefinition</code>.
  21      *
  22      * @return instance of type <code>RevisionAwareXPath</code>
  23      * @deprecated This method is deprecated because it is not defined in YANG metamodel. It is scheduled for removal
  24      *             in Boron release cycle.
  25      */
  26     @Deprecated
  27     RevisionAwareXPath getPathStatement();
  28
  29     /**
  30      * Returns true|false which represents argument of <code>require-instance</code> statement. This statement is the
  31      * substatement of the <code>type</code> statement.
  32      *
  33      * @return boolean value which is true if the <code>require-instance</code> statement is true and vice versa
  34      */
  35     boolean requireInstance();
  36 }