Add Enumeration yang-binding interface
[mdsal.git] / binding / yang-binding / src / main / java / org / opendaylight / yangtools / yang / binding / Enumeration.java
1 /*
2  * Copyright (c) 2018 Pantheon Technologies, s.r.o.  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.binding;
9
10 /**
11  * Interface implemented by all enumerations generated by YANG Binding.
12  *
13  * @author Robert Varga
14  */
15 public interface Enumeration {
16     /**
17      * Returns the assigned name of the enumeration item as it is specified in the input YANG.
18      *
19      * @return the assigned name of the enumeration item as it is specified in the input YANG.
20      */
21     String getName();
22
23     /**
24      * Returns the assigned value of the enumeration item as it is specified in the input YANG.
25      *
26      * @return the assigned value of the enumeration item as it is specified in the input YANG.
27      */
28     int getIntValue();
29 }