binding/mdsal-binding-generator-api/src/main/java/org/opendaylight/mdsal/binding/model/api/CodeGenerator.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 /**
  11  * Transforms virtual data to the concrete code in programming language.
  12  */
  13 public interface CodeGenerator {
  14     /**
  15      * Generates code for <code>type</code>.
  16      *
  17      * @param type Input type to be processed
  18      * @return generated JAVA code
  19      */
  20     String generate(Type type);
  21
  22     /**
  23      * Checks if the concrete instance of <code>type</code> fit to concrete implementation of this interface (e.g.
  24      * method return true if in <code>EnumGenerator</code> (which implements this interface) has input parameter of type
  25      * Enumeration (which is subtype of Type).
  26      *
  27      * @param type Input type to be processed
  28      * @return true if type is acceptable for processing.
  29      */
  30     boolean isAcceptable(Type type);
  31
  32     /**
  33      * Returns name of <code>type</code> parameter.
  34      *
  35      * @param type Input type to be processed
  36      * @return name of generated unit
  37      */
  38     String getUnitName(Type type);
  39 }