opendaylight/sal/yang-prototype/code-generator/maven-yang/src/main/java/org/opendaylight/controller/yang2sources/spi/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.controller.yang2sources.spi;
   9
  10 import java.io.File;
  11 import java.io.IOException;
  12 import java.util.Collection;
  13 import java.util.Set;
  14
  15 import org.opendaylight.controller.yang.model.api.Module;
  16 import org.opendaylight.controller.yang.model.api.SchemaContext;
  17
  18 /**
  19  * Classes implementing this interface can be submitted to maven-yang-plugin's
  20  * generate-sources goal.
  21  */
  22 public interface CodeGenerator {
  23
  24     /**
  25      * Generate sources from provided {@link SchemaContext}
  26      *
  27      * @param context
  28      *            parsed from yang files
  29      * @param outputBaseDir
  30      *            expected output directory for generated sources configured by
  31      *            user
  32      * @param yangModules
  33      *            yang modules parsed from yangFilesRootDir
  34      * @return collection of files that were generated from schema context
  35      * @throws IOException
  36      */
  37     Collection<File> generateSources(SchemaContext context, File outputBaseDir,
  38             Set<Module> yangModules) throws IOException;
  39 }