opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/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.controller.yang.model.api.type;
   9
  10 import java.util.List;
  11
  12 import org.opendaylight.controller.yang.model.api.SchemaNode;
  13 import org.opendaylight.controller.yang.model.api.TypeDefinition;
  14
  15 public interface EnumTypeDefinition extends TypeDefinition<EnumTypeDefinition> {
  16
  17     List<EnumPair> getValues();
  18
  19     interface EnumPair extends SchemaNode {
  20
  21         /**
  22          * The name to specify each assigned name of an enumeration type.
  23          *
  24          * @return name of each assigned name of an enumeration type.
  25          */
  26         public String getName();
  27
  28         /**
  29          * The "value" statement, which is optional, is used to associate an
  30          * integer value with the assigned name for the enum. This integer value
  31          * MUST be in the range -2147483648 to 2147483647, and it MUST be unique
  32          * within the enumeration type.
  33          *
  34          * @return integer value assigned to enumeration
  35          */
  36         public Integer getValue();
  37     }
  38 }