org.rodnansol.openapi.extender.generator

Class AbstractFileOutputResourceGenerator

java.lang.Object

org.rodnansol.openapi.extender.generator.AbstractFileOutputResourceGenerator

Direct Known Subclasses:

ApiResponseExampleFileOutputResourceGenerator, RequestBodyExampleFileOutputResourceGenerator

public abstract class AbstractFileOutputResourceGenerator
extends Object

Abstract class that generates the resource files

Field Summary

Fields

Modifier and Type	Field and Description
protected String	outputDirectory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFileOutputResourceGenerator(String outputDirectory)

Method Summary

Modifier and Type	Method and Description
protected abstract String	createFilePath(String operation, int status, String contentType, String name, String optionalDescription) Returns the file path/name based on the incoming parameters.
void	generateResources(ResourceGeneratorParams params) Generates resources based on the incoming object.
protected String	getFolderName() Returns the containing folder.

Methods inherited from class java.lang.Object

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

Field Detail

outputDirectory

protected final String outputDirectory

Constructor Detail

AbstractFileOutputResourceGenerator

protected AbstractFileOutputResourceGenerator(String outputDirectory)

Method Detail

generateResources

public void generateResources(ResourceGeneratorParams params)
                       throws IOException

Generates resources based on the incoming object.

Files are going to be created based on the operation and its dependencies.

Parameters:

params - parameter object with all necessary information.

Throws:

IOException - when resource/file generation fails.

createFilePath

protected abstract String createFilePath(String operation,
                                         int status,
                                         String contentType,
                                         String name,
                                         String optionalDescription)

Returns the file path/name based on the incoming parameters.

Returns:

created file path/name.

getFolderName

protected String getFolderName()

Returns the containing folder.

Parameters:

operation - operation's name.

Returns:

resource containing folder name.