binding/mdsal-binding-generator-api/src/main/java/org/opendaylight/mdsal/binding/model/api/type/builder/EnumBuilder.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.type.builder;
   9
  10 import org.opendaylight.mdsal.binding.model.api.Enumeration;
  11 import org.opendaylight.mdsal.binding.model.api.Type;
  12 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
  13
  14 /**
  15  * Enum Builder is interface that contains methods to build and instantiate Enumeration definition.
  16  *
  17  * @see Enumeration
  18  */
  19 public interface EnumBuilder extends Type, AnnotableTypeBuilder {
  20
  21     void setDescription(final String description);
  22
  23     Enumeration toInstance(final Type definingType);
  24
  25     /**
  26      * Updates this builder with data from <code>enumTypeDef</code>. Specifically this data represents list
  27      * of value-name pairs.
  28      *
  29      * @param enumTypeDef enum type definition as source of enum data for <code>enumBuilder</code>
  30      */
  31     void updateEnumPairsFromEnumTypeDef(final EnumTypeDefinition enumTypeDef);
  32 }