yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/UnsignedIntegerTypeDefinition.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 java.util.List;
  11 import javax.annotation.Nonnull;
  12 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  13
  14 /**
  15  * Contains the method for getting detail data about unsigned integer.
  16  * Specifically it is the method for getting the range value.
  17  */
  18 public interface UnsignedIntegerTypeDefinition extends TypeDefinition<UnsignedIntegerTypeDefinition> {
  19     /**
  20      * Returns range data of the instance of the type
  21      * <code>UnsignedIntegerTypeDefinition</code>. These are the effective constraints, e.g. they include
  22      * any range constraints imposed by base types.
  23      *
  24      * @return list of <code>RangeConstraint</code> which represents the YANG
  25      *         <code>range</code> substatement arguments.
  26      */
  27     @Nonnull List<RangeConstraint> getRangeConstraints();
  28 }