Class VelocityDescriptionGenerator

java.lang.Object

com.vouncherstudios.strawberry.minecraft.plugin.generator.velocity.VelocityDescriptionGenerator

All Implemented Interfaces:

DescriptionGenerator

public final class VelocityDescriptionGenerator
extends Object
implements DescriptionGenerator

Represents a VelocityExtension plugin description generator.

Field Summary

Fields inherited from interface DescriptionGenerator

INVALID_NAMESPACES

Constructor Summary

Constructors

Constructor	Description
VelocityDescriptionGenerator(StrawberryExtension strawberry)

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.

Methods inherited from class Object

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

Constructor Details

VelocityDescriptionGenerator

public VelocityDescriptionGenerator(@Nonnull
 StrawberryExtension strawberry)

Method Details

generate

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

Description copied from interface: DescriptionGenerator

Generates the description for the project.

Specified by:

generate in interface DescriptionGenerator

Parameters:

projectVersion - the project version

projectDescription - the project description

directory - the output file directory

validate

public void validate()
              throws InvalidPluginDescriptionException

Description copied from interface: DescriptionGenerator

Checks whether the generator has all mandatory parameters.

Specified by:

validate in interface DescriptionGenerator

Throws:

InvalidPluginDescriptionException - if it is missing any mandatory parameter