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.TypeDefinition;
  11
  12 /**
  13  * Contains methods for getting data from the <code>instance-identifier</code>
  14  * YANG built-in type.
  15  */
  16 public interface InstanceIdentifierTypeDefinition extends TypeDefinition<InstanceIdentifierTypeDefinition> {
  17     /**
  18      * Returns true|false which represents argument of <code>require-instance</code> statement. This statement is the
  19      * substatement of the <code>type</code> statement.
  20      *
  21      * @return boolean value which is true if the <code>require-instance</code> statement is true and vice versa
  22      */
  23     boolean requireInstance();
  24 }