binding/mdsal-binding-generator-api/src/main/java/org/opendaylight/mdsal/binding/model/api/Enumeration.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.mdsal.binding.model.api;
   9
  10 import java.util.List;
  11 import org.opendaylight.yangtools.yang.model.api.DocumentedNode;
  12
  13 /**
  14  * Interface provide methods for reading data of enumeration class.
  15  */
  16 public interface Enumeration extends GeneratedType {
  17     /**
  18      * Returns list of the couples - name and value.
  19      *
  20      * @return list of the enumeration pairs.
  21      */
  22     List<Pair> getValues();
  23
  24     /**
  25      * Formats enumeration according to rules of the programming language.
  26      *
  27      * @return string with source code in some programming language
  28      */
  29     String toFormattedString();
  30
  31     /**
  32      * Interface is used for reading enumeration item. It means item's name and its value.
  33      */
  34     interface Pair extends DocumentedNode.WithStatus {
  35         /**
  36          * Returns the name of the enumeration item as it is specified in the input YANG.
  37          *
  38          * @return the name of the enumeration item as it is specified in the input YANG.
  39          */
  40         String getName();
  41
  42         /**
  43          * Returns the binding representation for the name of the enumeration item.
  44          *
  45          * @return the binding representation for the name of the enumeration item.
  46          */
  47         String getMappedName();
  48
  49         /**
  50          * Returns value of the enumeration item.
  51          *
  52          * @return the value of the enumeration item.
  53          */
  54         int getValue();
  55     }
  56 }