yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/DecimalTypeDefinition.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 /**
  11  * Contains methods for getting data from the YANG <code>type</code> substatement for <code>decimal64</code> built-in
  12  * type.
  13  */
  14 public interface DecimalTypeDefinition extends RangeRestrictedTypeDefinition<DecimalTypeDefinition> {
  15     /**
  16      * Returns integer between 1 and 18 inclusively.
  17      *
  18      * <p>
  19      * The "fraction-digits" statement controls the size of the minimum
  20      * difference between values of a decimal64 type, by restricting the value
  21      * space to numbers that are expressible as "i x 10^-n" where n is the
  22      * fraction-digits argument.
  23      *
  24      * @return number of fraction digits
  25      */
  26     int getFractionDigits();
  27 }