com.exasol.projectkeeper.shared.config.ProjectKeeperConfig Maven / Gradle / Ivy
package com.exasol.projectkeeper.shared.config;
import java.util.*;
/**
* This class represents the project-keeper configuration.
*
* Use {@link ProjectKeeperConfig#builder()} for creating new instances.
*/
public final class ProjectKeeperConfig {
private final List sources;
private final List linkReplacements;
// [impl->dsn~excluding~1]
private final List excludes;
private final VersionConfig versionConfig;
private final BuildOptions buildOptions;
private ProjectKeeperConfig(final Builder builder) {
this.sources = Objects.requireNonNull(builder.sources, "sources");
this.linkReplacements = Objects.requireNonNull(builder.linkReplacements, "linkReplacements");
this.excludes = Objects.requireNonNull(builder.excludes, "excludes");
this.versionConfig = builder.versionConfig;
this.buildOptions = Objects.requireNonNull(builder.buildOptions, "buildOptions");
}
/**
* Get all sources.
*
* @return List with source-projects to crawl
*/
public List getSources() {
return this.sources;
}
/**
* Get link replacements.
*
* @return List of replacements for broken links
*/
public List getLinkReplacements() {
return this.linkReplacements;
}
/**
* Get excludes.
*
* @return List of regular expressions that match validation messages to exclude
*/
public List getExcludes() {
return this.excludes;
}
/**
* Get version config.
*
* @return project version configuration
*/
public VersionConfig getVersionConfig() {
return this.versionConfig;
}
/**
* Get build options.
*
* @return CI build options
*/
public BuildOptions getCiBuildConfig() {
return this.buildOptions;
}
/**
* Create a new builder.
*
* @return a new builder for creating {@link ProjectKeeperConfig} instances
*/
public static ProjectKeeperConfig.Builder builder() {
return new ProjectKeeperConfig.Builder();
}
/**
* Builder for creating {@link ProjectKeeperConfig} instances.
*/
public static class Builder {
private List sources = Collections.emptyList();
private List linkReplacements = Collections.emptyList();
private List excludes = Collections.emptyList();
private VersionConfig versionConfig;
private BuildOptions buildOptions = BuildOptions.builder().build();
private Builder() {
// empty by intention
}
/**
* Set sources.
*
* @param sources List with source-projects to crawl
* @return {@code this}.
*/
public ProjectKeeperConfig.Builder sources(final List sources) {
this.sources = sources;
return this;
}
/**
* Set link replacements.
*
* @param linkReplacements List of replacements for broken links
* @return {@code this}.
*/
public ProjectKeeperConfig.Builder linkReplacements(final List linkReplacements) {
this.linkReplacements = linkReplacements;
return this;
}
/**
* Set excludes.
*
* @param excludes List of regular expressions that match validation messages to exclude
* @return {@code this}.
*/
public ProjectKeeperConfig.Builder excludes(final List excludes) {
this.excludes = excludes;
return this;
}
/**
* Set version config.
*
* @param versionConfig project version configuration
* @return {@code this}.
*/
public ProjectKeeperConfig.Builder versionConfig(final VersionConfig versionConfig) {
this.versionConfig = versionConfig;
return this;
}
/**
* Set build options.
*
* @param buildOptions options for project build workflows
* @return {@code this}.
*/
public ProjectKeeperConfig.Builder buildOptions(final BuildOptions buildOptions) {
if (buildOptions != null) {
this.buildOptions = buildOptions;
}
return this;
}
/**
* Build a new instance.
*
* @return a new instance
*/
public ProjectKeeperConfig build() {
return new ProjectKeeperConfig(this);
}
}
@Override
public String toString() {
return "ProjectKeeperConfig [sources=" + this.sources + ", linkReplacements=" + this.linkReplacements
+ ", excludes=" + this.excludes + ", versionConfig=" + this.versionConfig + ", buildOptions="
+ this.buildOptions + "]";
}
@Override
public int hashCode() {
return Objects.hash(this.sources, this.linkReplacements, this.excludes, this.versionConfig, this.buildOptions);
}
@Override
public boolean equals(final Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
final ProjectKeeperConfig other = (ProjectKeeperConfig) obj;
return Objects.equals(this.sources, other.sources)
&& Objects.equals(this.linkReplacements, other.linkReplacements)
&& Objects.equals(this.excludes, other.excludes)
&& Objects.equals(this.versionConfig, other.versionConfig)
&& Objects.equals(this.buildOptions, other.buildOptions);
}
}