model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/RequireInstanceRestrictedTypeDefinition.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  * Interface for {@link TypeDefinition}s which can be restricted through a require-instance statement.
  14  *
  15  * @param <T> Concrete {@link TypeDefinition} subinterface
  16  */
  17 public interface RequireInstanceRestrictedTypeDefinition<T extends TypeDefinition<T>> extends TypeDefinition<T> {
  18     /**
  19      * Returns true or false which represents argument of <code>require-instance</code> statement. This statement is
  20      * the substatement of the <code>type</code> statement.
  21      *
  22      * @return boolean value which is true if the <code>require-instance</code> statement is true and vice versa
  23      */
  24     boolean requireInstance();
  25 }