Package com.io7m.minisite.core

Interface MinConfigurationType

All Known Implementing Classes:

MinConfiguration

@Immutable
public interface MinConfigurationType

Configurations for sites.

Method Summary

Modifier and Type	Method	Description
java.util.Optional<MinBugTrackerConfiguration>	bugTracker()
java.lang.String	centralReposPath()
java.util.Optional<MinChangesConfiguration>	changelog()
java.util.Optional<java.nio.file.Path>	documentation()
java.util.Optional<java.nio.file.Path>	features()
java.util.Optional<java.nio.file.Path>	license()
java.util.Optional<java.nio.file.Path>	overview()
java.lang.String	projectGroupName()
io.vavr.collection.Vector<java.lang.String>	projectModules()
java.lang.String	projectName()
java.lang.String	release()
java.util.Optional<MinSourcesConfiguration>	sources()

Method Detail

projectName

@Parameter
java.lang.String projectName()

Returns:

The name of the project

projectGroupName

@Parameter
java.lang.String projectGroupName()

Returns:

The group name of the project

projectModules

@Parameter
io.vavr.collection.Vector<java.lang.String> projectModules()

Returns:

The project modules

release

@Parameter
java.lang.String release()

Returns:

The version number of the current release

centralReposPath

@Parameter
java.lang.String centralReposPath()

Returns:

The path to the project within the Central Repository

overview

@Parameter
java.util.Optional<java.nio.file.Path> overview()

Returns:

An XHTML file containing an overview of the project

features

@Parameter
java.util.Optional<java.nio.file.Path> features()

Returns:

An XHTML file containing the features of the project

documentation

@Parameter
java.util.Optional<java.nio.file.Path> documentation()

Returns:

An XHTML file containing the documentation links of the project

changelog

@Parameter
java.util.Optional<MinChangesConfiguration> changelog()

Returns:

The changelog configuration, if any

license

@Parameter
java.util.Optional<java.nio.file.Path> license()

Returns:

A plain text file containing the project license

bugTracker

@Parameter
java.util.Optional<MinBugTrackerConfiguration> bugTracker()

Returns:

The bug tracker configuration, if any

sources

@Parameter
java.util.Optional<MinSourcesConfiguration> sources()

Returns:

The project source configuration, if any