yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/EnumTypeDefinition.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
  12 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  13 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  14
  15 /**
  16  *
  17  * Makes is possible to access to the individual enumeration values of this
  18  * type.
  19  *
  20  */
  21 public interface EnumTypeDefinition extends TypeDefinition<EnumTypeDefinition> {
  22
  23     /**
  24      * Returns all enumeration values.
  25      *
  26      * @return list of <code>EnumPair</code> type instastances which contain the
  27      *         data about all individual enumeration pairs of
  28      *         <code>enumeration</code> YANG built-in type
  29      */
  30     List<EnumPair> getValues();
  31
  32     /**
  33      *
  34      * Contains the methods for accessing the data about the concrete
  35      * enumeration item which represents <code>enum</code> YANG type.
  36      */
  37     interface EnumPair extends SchemaNode {
  38
  39         /**
  40          * The name to specify each assigned name of an enumeration type.
  41          *
  42          * @return name of each assigned name of an enumeration type.
  43          */
  44         public String getName();
  45
  46         /**
  47          * The "value" statement, which is optional, is used to associate an
  48          * integer value with the assigned name for the enum. This integer value
  49          * MUST be in the range -2147483648 to 2147483647, and it MUST be unique
  50          * within the enumeration type.
  51          *
  52          * @return integer value assigned to enumeration
  53          */
  54         public Integer getValue();
  55     }
  56 }