yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/LeafrefTypeDefinition.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 public interface LeafrefTypeDefinition extends TypeDefinition<LeafrefTypeDefinition> {
  14
  15     RevisionAwareXPath getPathStatement();
  16
  17     /**
  18      * All implementations should override this method.
  19      * The default definition of this method is used only in YANG 1.0 (RFC6020) implementation of
  20      * LeafrefTypeDefinition which does not support require-instance statement.
  21      * YANG leafref type has been changed in YANG 1.1 (RFC7950) and now allows require-instance statement.
  22      *
  23      * @return boolean value which is true if the <code>require-instance</code> statement is true and vice versa
  24      */
  25      // FIXME: version 2.0.0: make this method non-default
  26     default boolean requireInstance() {
  27         return true;
  28     }
  29 }