Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- addAllCssIncludes(Iterable<String>) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Adds elements to
cssIncludeslist. - addAllProjectModules(Iterable<String>) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Adds elements to
projectModuleslist. - addCssIncludes(String) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Adds one element to
cssIncludeslist. - addCssIncludes(String...) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Adds elements to
cssIncludeslist. - addProjectModules(String) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Adds one element to
projectModuleslist. - addProjectModules(String...) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Adds elements to
projectModuleslist.
B
- bugTracker() - Method in class com.io7m.minisite.core.MinConfiguration
- bugTracker() - Method in interface com.io7m.minisite.core.MinConfigurationType
- build() - Method in class com.io7m.minisite.core.MinBugTrackerConfiguration.Builder
-
Builds a new
MinBugTrackerConfiguration. - build() - Method in class com.io7m.minisite.core.MinChangesConfiguration.Builder
-
Builds a new
MinChangesConfiguration. - build() - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Builds a new
MinConfiguration. - build() - Method in class com.io7m.minisite.core.MinSourcesConfiguration.Builder
-
Builds a new
MinSourcesConfiguration. - builder() - Static method in class com.io7m.minisite.core.MinBugTrackerConfiguration
-
Creates a builder for
MinBugTrackerConfiguration. - builder() - Static method in class com.io7m.minisite.core.MinChangesConfiguration
-
Creates a builder for
MinChangesConfiguration. - builder() - Static method in class com.io7m.minisite.core.MinConfiguration
-
Creates a builder for
MinConfiguration. - builder() - Static method in class com.io7m.minisite.core.MinSourcesConfiguration
-
Creates a builder for
MinSourcesConfiguration.
C
- centralReposPath() - Method in class com.io7m.minisite.core.MinConfiguration
- centralReposPath() - Method in interface com.io7m.minisite.core.MinConfigurationType
- changelog() - Method in class com.io7m.minisite.core.MinConfiguration
- changelog() - Method in interface com.io7m.minisite.core.MinConfigurationType
- changelog(Document, MinChangesConfiguration) - Static method in class com.io7m.minisite.core.internal.MinXHTMLChangelogs
-
Serialize the changelog.
- com.io7m.minisite.core - package com.io7m.minisite.core
-
Core types and functions.
- com.io7m.minisite.core.internal - package com.io7m.minisite.core.internal
-
Core types and functions [Internal classes].
- copyOf(MinBugTrackerConfigurationType) - Static method in class com.io7m.minisite.core.MinBugTrackerConfiguration
-
Creates an immutable copy of a
MinBugTrackerConfigurationTypevalue. - copyOf(MinChangesConfigurationType) - Static method in class com.io7m.minisite.core.MinChangesConfiguration
-
Creates an immutable copy of a
MinChangesConfigurationTypevalue. - copyOf(MinConfigurationType) - Static method in class com.io7m.minisite.core.MinConfiguration
-
Creates an immutable copy of a
MinConfigurationTypevalue. - copyOf(MinSourcesConfigurationType) - Static method in class com.io7m.minisite.core.MinSourcesConfiguration
-
Creates an immutable copy of a
MinSourcesConfigurationTypevalue. - create(MinConfiguration) - Static method in class com.io7m.minisite.core.MinSite
-
Create a site generator for the given config.
- cssGenerateStyle() - Method in class com.io7m.minisite.core.MinConfiguration
- cssGenerateStyle() - Method in interface com.io7m.minisite.core.MinConfigurationType
- cssIncludes() - Method in class com.io7m.minisite.core.MinConfiguration
- cssIncludes() - Method in interface com.io7m.minisite.core.MinConfigurationType
D
- document(Document) - Method in class com.io7m.minisite.core.MinSite
-
Generate a site.
- documentation() - Method in class com.io7m.minisite.core.MinConfiguration
- documentation() - Method in interface com.io7m.minisite.core.MinConfigurationType
E
- equals(Object) - Method in class com.io7m.minisite.core.MinBugTrackerConfiguration
-
This instance is equal to all instances of
MinBugTrackerConfigurationthat have equal attribute values. - equals(Object) - Method in class com.io7m.minisite.core.MinChangesConfiguration
-
This instance is equal to all instances of
MinChangesConfigurationthat have equal attribute values. - equals(Object) - Method in class com.io7m.minisite.core.MinConfiguration
-
This instance is equal to all instances of
MinConfigurationthat have equal attribute values. - equals(Object) - Method in class com.io7m.minisite.core.MinSourcesConfiguration
-
This instance is equal to all instances of
MinSourcesConfigurationthat have equal attribute values. - evaluate(Document, MinSourcesConfiguration) - Method in class com.io7m.minisite.core.MinSourcesGitProvider
- evaluate(Document, MinSourcesConfiguration) - Method in interface com.io7m.minisite.core.MinSourcesProviderType
F
- features() - Method in class com.io7m.minisite.core.MinConfiguration
- features() - Method in interface com.io7m.minisite.core.MinConfigurationType
- feedEmail() - Method in class com.io7m.minisite.core.MinChangesConfiguration
- feedEmail() - Method in interface com.io7m.minisite.core.MinChangesConfigurationType
- file() - Method in class com.io7m.minisite.core.MinChangesConfiguration
- file() - Method in interface com.io7m.minisite.core.MinChangesConfigurationType
- from(MinBugTrackerConfigurationType) - Method in class com.io7m.minisite.core.MinBugTrackerConfiguration.Builder
-
Fill a builder with attribute values from the provided
MinBugTrackerConfigurationTypeinstance. - from(MinChangesConfigurationType) - Method in class com.io7m.minisite.core.MinChangesConfiguration.Builder
-
Fill a builder with attribute values from the provided
MinChangesConfigurationTypeinstance. - from(MinConfigurationType) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Fill a builder with attribute values from the provided
MinConfigurationTypeinstance. - from(MinSourcesConfigurationType) - Method in class com.io7m.minisite.core.MinSourcesConfiguration.Builder
-
Fill a builder with attribute values from the provided
MinSourcesConfigurationTypeinstance.
H
- h2(Document, String) - Static method in class com.io7m.minisite.core.internal.MinXHTML
-
Generate an h2 element.
- hashCode() - Method in class com.io7m.minisite.core.MinBugTrackerConfiguration
-
Computes a hash code from attributes:
system,uri. - hashCode() - Method in class com.io7m.minisite.core.MinChangesConfiguration
-
Computes a hash code from attributes:
file,feedEmail. - hashCode() - Method in class com.io7m.minisite.core.MinConfiguration
-
Computes a hash code from attributes:
projectName,projectGroupName,projectModules,release,centralReposPath,header,overview,features,documentation,changelog,license,bugTracker,sources,cssIncludes,cssGenerateStyle. - hashCode() - Method in class com.io7m.minisite.core.MinSourcesConfiguration
-
Computes a hash code from attributes:
system,uri. - header() - Method in class com.io7m.minisite.core.MinConfiguration
- header() - Method in interface com.io7m.minisite.core.MinConfigurationType
L
- license() - Method in class com.io7m.minisite.core.MinConfiguration
- license() - Method in interface com.io7m.minisite.core.MinConfigurationType
- link(Document, String, String) - Static method in class com.io7m.minisite.core.internal.MinXHTML
-
Generate a link element.
- listItem(Document, Element) - Static method in class com.io7m.minisite.core.internal.MinXHTML
-
Generate a list item element.
M
- MinBugTrackerConfiguration - Class in com.io7m.minisite.core
-
Configurations for bug trackers.
- MinBugTrackerConfiguration.Builder - Class in com.io7m.minisite.core
-
Builds instances of type
MinBugTrackerConfiguration. - MinBugTrackerConfigurationType - Interface in com.io7m.minisite.core
-
Configurations for bug trackers.
- MinChangesConfiguration - Class in com.io7m.minisite.core
-
Configurations for changelogs.
- MinChangesConfiguration.Builder - Class in com.io7m.minisite.core
-
Builds instances of type
MinChangesConfiguration. - MinChangesConfigurationType - Interface in com.io7m.minisite.core
-
Configurations for changelogs.
- MinConfiguration - Class in com.io7m.minisite.core
-
Configurations for sites.
- MinConfiguration.Builder - Class in com.io7m.minisite.core
-
Builds instances of type
MinConfiguration. - MinConfigurationType - Interface in com.io7m.minisite.core
-
Configurations for sites.
- MinSite - Class in com.io7m.minisite.core
-
A site generator.
- MinSourcesConfiguration - Class in com.io7m.minisite.core
-
Configurations for source code repositories.
- MinSourcesConfiguration.Builder - Class in com.io7m.minisite.core
-
Builds instances of type
MinSourcesConfiguration. - MinSourcesConfigurationType - Interface in com.io7m.minisite.core
-
Configurations for source code repositories.
- MinSourcesGitProvider - Class in com.io7m.minisite.core
-
A source provider for git repositories.
- MinSourcesGitProvider() - Constructor for class com.io7m.minisite.core.MinSourcesGitProvider
-
Construct a provider.
- MinSourcesProviderType - Interface in com.io7m.minisite.core
-
The type of providers for source sections.
- MinXHTML - Class in com.io7m.minisite.core.internal
-
Functions to generate XHTML elements.
- MinXHTMLChangelogs - Class in com.io7m.minisite.core.internal
-
Terse functions to serialize changelogs.
- MinXMLParse - Class in com.io7m.minisite.core.internal
-
Terse functions to parse XML files.
O
- of(String, String, Iterable<String>, String, String, Optional<? extends Path>, Optional<? extends Path>, Optional<? extends Path>, Optional<? extends Path>, Optional<? extends MinChangesConfiguration>, Optional<? extends Path>, Optional<? extends MinBugTrackerConfiguration>, Optional<? extends MinSourcesConfiguration>, Iterable<String>, boolean) - Static method in class com.io7m.minisite.core.MinConfiguration
-
Construct a new immutable
MinConfigurationinstance. - of(String, String, List<String>, String, String, Optional<Path>, Optional<Path>, Optional<Path>, Optional<Path>, Optional<MinChangesConfiguration>, Optional<Path>, Optional<MinBugTrackerConfiguration>, Optional<MinSourcesConfiguration>, List<String>, boolean) - Static method in class com.io7m.minisite.core.MinConfiguration
-
Construct a new immutable
MinConfigurationinstance. - of(String, URI) - Static method in class com.io7m.minisite.core.MinBugTrackerConfiguration
-
Construct a new immutable
MinBugTrackerConfigurationinstance. - of(String, URI) - Static method in class com.io7m.minisite.core.MinSourcesConfiguration
-
Construct a new immutable
MinSourcesConfigurationinstance. - of(Path, String) - Static method in class com.io7m.minisite.core.MinChangesConfiguration
-
Construct a new immutable
MinChangesConfigurationinstance. - overview() - Method in class com.io7m.minisite.core.MinConfiguration
- overview() - Method in interface com.io7m.minisite.core.MinConfigurationType
P
- parseFileUnchecked(Document, Path) - Static method in class com.io7m.minisite.core.internal.MinXMLParse
-
Parse a file and return the root element, owned by
document. - projectGroupName() - Method in class com.io7m.minisite.core.MinConfiguration
- projectGroupName() - Method in interface com.io7m.minisite.core.MinConfigurationType
- projectModules() - Method in class com.io7m.minisite.core.MinConfiguration
- projectModules() - Method in interface com.io7m.minisite.core.MinConfigurationType
- projectName() - Method in class com.io7m.minisite.core.MinConfiguration
- projectName() - Method in interface com.io7m.minisite.core.MinConfigurationType
R
- release() - Method in class com.io7m.minisite.core.MinConfiguration
- release() - Method in interface com.io7m.minisite.core.MinConfigurationType
S
- setBugTracker(MinBugTrackerConfiguration) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the optional value
bugTrackerto bugTracker. - setBugTracker(Optional<? extends MinBugTrackerConfiguration>) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the optional value
bugTrackerto bugTracker. - setCentralReposPath(String) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the value for the
centralReposPathattribute. - setChangelog(MinChangesConfiguration) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the optional value
changelogto changelog. - setChangelog(Optional<? extends MinChangesConfiguration>) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the optional value
changelogto changelog. - setCssGenerateStyle(boolean) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the value for the
cssGenerateStyleattribute. - setCssIncludes(Iterable<String>) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Sets or replaces all elements for
cssIncludeslist. - setDocumentation(Path) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the optional value
documentationto documentation. - setDocumentation(Optional<? extends Path>) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the optional value
documentationto documentation. - setFeatures(Path) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the optional value
featuresto features. - setFeatures(Optional<? extends Path>) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the optional value
featuresto features. - setFeedEmail(String) - Method in class com.io7m.minisite.core.MinChangesConfiguration.Builder
-
Initializes the value for the
feedEmailattribute. - setFile(Path) - Method in class com.io7m.minisite.core.MinChangesConfiguration.Builder
-
Initializes the value for the
fileattribute. - setHeader(Path) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the optional value
headerto header. - setHeader(Optional<? extends Path>) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the optional value
headerto header. - setLicense(Path) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the optional value
licenseto license. - setLicense(Optional<? extends Path>) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the optional value
licenseto license. - setOverview(Path) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the optional value
overviewto overview. - setOverview(Optional<? extends Path>) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the optional value
overviewto overview. - setProjectGroupName(String) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the value for the
projectGroupNameattribute. - setProjectModules(Iterable<String>) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Sets or replaces all elements for
projectModuleslist. - setProjectName(String) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the value for the
projectNameattribute. - setRelease(String) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the value for the
releaseattribute. - setSources(MinSourcesConfiguration) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the optional value
sourcesto sources. - setSources(Optional<? extends MinSourcesConfiguration>) - Method in class com.io7m.minisite.core.MinConfiguration.Builder
-
Initializes the optional value
sourcesto sources. - setSystem(String) - Method in class com.io7m.minisite.core.MinBugTrackerConfiguration.Builder
-
Initializes the value for the
systemattribute. - setSystem(String) - Method in class com.io7m.minisite.core.MinSourcesConfiguration.Builder
-
Initializes the value for the
systemattribute. - setUri(URI) - Method in class com.io7m.minisite.core.MinBugTrackerConfiguration.Builder
-
Initializes the value for the
uriattribute. - setUri(URI) - Method in class com.io7m.minisite.core.MinSourcesConfiguration.Builder
-
Initializes the value for the
uriattribute. - sources() - Method in class com.io7m.minisite.core.MinConfiguration
- sources() - Method in interface com.io7m.minisite.core.MinConfigurationType
- system() - Method in class com.io7m.minisite.core.MinBugTrackerConfiguration
- system() - Method in interface com.io7m.minisite.core.MinBugTrackerConfigurationType
- system() - Method in class com.io7m.minisite.core.MinSourcesConfiguration
- system() - Method in interface com.io7m.minisite.core.MinSourcesConfigurationType
- system() - Method in class com.io7m.minisite.core.MinSourcesGitProvider
- system() - Method in interface com.io7m.minisite.core.MinSourcesProviderType
T
- toString() - Method in class com.io7m.minisite.core.MinBugTrackerConfiguration
-
Prints the immutable value
MinBugTrackerConfigurationwith attribute values. - toString() - Method in class com.io7m.minisite.core.MinChangesConfiguration
-
Prints the immutable value
MinChangesConfigurationwith attribute values. - toString() - Method in class com.io7m.minisite.core.MinConfiguration
-
Prints the immutable value
MinConfigurationwith attribute values. - toString() - Method in class com.io7m.minisite.core.MinSourcesConfiguration
-
Prints the immutable value
MinSourcesConfigurationwith attribute values.
U
- uri() - Method in class com.io7m.minisite.core.MinBugTrackerConfiguration
- uri() - Method in interface com.io7m.minisite.core.MinBugTrackerConfigurationType
- uri() - Method in class com.io7m.minisite.core.MinSourcesConfiguration
- uri() - Method in interface com.io7m.minisite.core.MinSourcesConfigurationType
W
- withBugTracker(MinBugTrackerConfiguration) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting a present value for the optional
bugTrackerattribute. - withBugTracker(Optional<? extends MinBugTrackerConfiguration>) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting an optional value for the
bugTrackerattribute. - withCentralReposPath(String) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting a value for the
centralReposPathattribute. - withChangelog(MinChangesConfiguration) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting a present value for the optional
changelogattribute. - withChangelog(Optional<? extends MinChangesConfiguration>) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting an optional value for the
changelogattribute. - withCssGenerateStyle(boolean) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting a value for the
cssGenerateStyleattribute. - withCssIncludes(Iterable<String>) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object with elements that replace the content of
cssIncludes. - withCssIncludes(String...) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object with elements that replace the content of
cssIncludes. - withDocumentation(Path) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting a present value for the optional
documentationattribute. - withDocumentation(Optional<? extends Path>) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting an optional value for the
documentationattribute. - withFeatures(Path) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting a present value for the optional
featuresattribute. - withFeatures(Optional<? extends Path>) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting an optional value for the
featuresattribute. - withFeedEmail(String) - Method in class com.io7m.minisite.core.MinChangesConfiguration
-
Copy the current immutable object by setting a value for the
feedEmailattribute. - withFile(Path) - Method in class com.io7m.minisite.core.MinChangesConfiguration
-
Copy the current immutable object by setting a value for the
fileattribute. - withHeader(Path) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting a present value for the optional
headerattribute. - withHeader(Optional<? extends Path>) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting an optional value for the
headerattribute. - withLicense(Path) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting a present value for the optional
licenseattribute. - withLicense(Optional<? extends Path>) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting an optional value for the
licenseattribute. - withOverview(Path) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting a present value for the optional
overviewattribute. - withOverview(Optional<? extends Path>) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting an optional value for the
overviewattribute. - withProjectGroupName(String) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting a value for the
projectGroupNameattribute. - withProjectModules(Iterable<String>) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object with elements that replace the content of
projectModules. - withProjectModules(String...) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object with elements that replace the content of
projectModules. - withProjectName(String) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting a value for the
projectNameattribute. - withRelease(String) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting a value for the
releaseattribute. - withSources(MinSourcesConfiguration) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting a present value for the optional
sourcesattribute. - withSources(Optional<? extends MinSourcesConfiguration>) - Method in class com.io7m.minisite.core.MinConfiguration
-
Copy the current immutable object by setting an optional value for the
sourcesattribute. - withSystem(String) - Method in class com.io7m.minisite.core.MinBugTrackerConfiguration
-
Copy the current immutable object by setting a value for the
systemattribute. - withSystem(String) - Method in class com.io7m.minisite.core.MinSourcesConfiguration
-
Copy the current immutable object by setting a value for the
systemattribute. - withUri(URI) - Method in class com.io7m.minisite.core.MinBugTrackerConfiguration
-
Copy the current immutable object by setting a value for the
uriattribute. - withUri(URI) - Method in class com.io7m.minisite.core.MinSourcesConfiguration
-
Copy the current immutable object by setting a value for the
uriattribute.
X
A B C D E F H L M O P R S T U W XAll Classes and Interfaces|All Packages|Constant Field Values