io.protostuff.compiler.model.ModuleConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of protostuff-parser Show documentation

parser for .proto files

There is a newer version: 3.1.40

package io.protostuff.compiler.model;

import org.immutables.value.Value;

import java.nio.file.Path;
import java.util.List;
import java.util.Map;

/**
 * @author Kostiantyn Shchepanovskyi
 */
@Value.Immutable
public interface ModuleConfiguration {

    /**
     * Module name.
     */
    String getName();

    /**
     * List of "include" folders used to search for proto files.
     */
    List getIncludePaths();

    /**
     * List of proto files to compile.
     */
    List getProtoFiles();

    /**
     * Generator used to compile proto files. Currently following generators
     * are supported:
     *
     * 
     *     java - produces Java source code that uses protostuff runtime;
     *     html - produces HTML documentation;
     *     st4 - generic generator, you should provide custom template
     *     (StringTemplate 4) using {@linkplain #getOptions()}.
     *     
     * 
     */
    String getGenerator();

    /**
     * Output directory.
     */
    String getOutput();

    /**
     * Map of custom settings passed to the generator.
     */
    Map getOptions();

}