org.openapitools.codegen

Class AbstractGenerator

java.lang.Object

org.openapitools.codegen.AbstractGenerator

All Implemented Interfaces:

TemplatingGenerator

Direct Known Subclasses:

DefaultGenerator

public abstract class AbstractGenerator
extends Object
implements TemplatingGenerator

Constructor Summary

Constructors

Constructor and Description
AbstractGenerator()

Method Summary

Modifier and Type	Method and Description
boolean	embeddedTemplateExists(String name)
String	getCPResourcePath(String name)
abstract boolean	getEnableMinimalUpdate() Is the minimal-file-update option enabled?
String	getFullTemplateFile(CodegenConfig config, String templateFile) Get the template file path with template dir prepended, and use the library template if exists.
Reader	getTemplateReader(String name)
String	readResourceContents(String resourceFilePath)
String	readTemplate(String name)
File	writeToFile(String filename, byte[] contents) Write bytes to a file
File	writeToFile(String filename, String contents) Write String to a file, formatting as UTF-8

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openapitools.codegen.api.TemplatingGenerator

getFullTemplateContents, getFullTemplatePath

Constructor Detail

AbstractGenerator

public AbstractGenerator()

Method Detail

getEnableMinimalUpdate

public abstract boolean getEnableMinimalUpdate()

Is the minimal-file-update option enabled?

Returns:

Option value

writeToFile

public File writeToFile(String filename,
                        String contents)
                 throws IOException

Write String to a file, formatting as UTF-8

Parameters:

filename - The name of file to write

contents - The contents string.

Returns:

File representing the written file.

Throws:

IOException - If file cannot be written.

writeToFile

public File writeToFile(String filename,
                        byte[] contents)
                 throws IOException

Write bytes to a file

Parameters:

filename - The name of file to write

contents - The contents bytes. Typically this is a UTF-8 formatted string.

Returns:

File representing the written file.

Throws:

IOException - If file cannot be written.

readTemplate

public String readTemplate(String name)

getTemplateReader

public Reader getTemplateReader(String name)

getFullTemplateFile

public String getFullTemplateFile(CodegenConfig config,
                                  String templateFile)

Get the template file path with template dir prepended, and use the library template if exists.

Parameters:

config - Codegen config

templateFile - Template file

Returns:

String Full template file path

readResourceContents

public String readResourceContents(String resourceFilePath)

embeddedTemplateExists

public boolean embeddedTemplateExists(String name)

getCPResourcePath

public String getCPResourcePath(String name)