Interface DescriptionGenerator

All Known Implementing Classes:

PaperDescriptionGenerator, VelocityDescriptionGenerator

public interface DescriptionGenerator

Represents a description generator. It is used to generate a plugin description on the specified platform.

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	INVALID_NAMESPACES

Method Summary

Modifier and Type	Method	Description
void	generate(String projectVersion, String projectDescription, org.gradle.api.file.Directory directory)	Generates the description for the project.
void	validate()	Checks whether the generator has all mandatory parameters.

Field Details

INVALID_NAMESPACES

static final Set<String> INVALID_NAMESPACES

Method Details

generate

void generate(@Nonnull
 String projectVersion,
 @Nullable
 String projectDescription,
 @Nonnull
 org.gradle.api.file.Directory directory)

Generates the description for the project.

Parameters:

projectVersion - the project version

projectDescription - the project description

directory - the output file directory

validate

void validate()
       throws InvalidPluginDescriptionException

Checks whether the generator has all mandatory parameters.

Throws:

InvalidPluginDescriptionException - if it is missing any mandatory parameter