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 annotation definitions associated with enumeration type.
  19      *
  20      * @return list of annotation definitions associated with enumeration type.
  21      */
  22     @Override
  23     List<AnnotationType> getAnnotations();
  24
  25     @Override
  26     Type getParentType();
  27
  28     /**
  29      * Returns list of the couples - name and value.
  30      *
  31      * @return list of the enumeration pairs.
  32      */
  33     List<Pair> getValues();
  34
  35     /**
  36      * Formats enumeration according to rules of the programming language.
  37      *
  38      * @return string with source code in some programming language
  39      */
  40     String toFormattedString();
  41
  42     /**
  43      * Interface is used for reading enumeration item. It means item's name and its value.
  44      */
  45     interface Pair extends DocumentedNode.WithStatus {
  46         /**
  47          * Returns the name of the enumeration item as it is specified in the input YANG.
  48          *
  49          * @return the name of the enumeration item as it is specified in the input YANG.
  50          */
  51         String getName();
  52
  53         /**
  54          * Returns the binding representation for the name of the enumeration item.
  55          *
  56          * @return the binding representation for the name of the enumeration item.
  57          */
  58         String getMappedName();
  59
  60         /**
  61          * Returns value of the enumeration item.
  62          *
  63          * @return the value of the enumeration item.
  64          */
  65         int getValue();
  66     }
  67 }