Package hydra.build.format

Class RepositoryDescriptor

java.lang.Object

hydra.build.format.RepositoryDescriptor

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RepositoryDescriptor>

public class RepositoryDescriptor
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<RepositoryDescriptor>

The repository descriptor (hydra.json at the repository root): release and host versions, host consumption overrides, publication metadata, and the list of source packages.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RepositoryDescriptor.Builder	A fluent builder for RepositoryDescriptor.

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String	author	The author attribution for published artifacts
static Name	AUTHOR	Name of the hydra.build.format.RepositoryDescriptor.author field.
static Name	CURRENT_VERSION	Name of the hydra.build.format.RepositoryDescriptor.currentVersion field.
Version	currentVersion	The version currently under development
java.lang.String	group	The group identifier under which artifacts are published, e.g.
static Name	GROUP	Name of the hydra.build.format.RepositoryDescriptor.group field.
static Name	HOST_OVERRIDES	Name of the hydra.build.format.RepositoryDescriptor.hostOverrides field.
static Name	HOST_VERSION	Name of the hydra.build.format.RepositoryDescriptor.hostVersion field.
java.util.Map<LanguageName,HostOverride>	hostOverrides	Per-host-language overrides of the default published-host consumption
Version	hostVersion	The published host version consumed by default when generating code
java.lang.String	license	The license identifier for published artifacts, e.g.
static Name	LICENSE	Name of the hydra.build.format.RepositoryDescriptor.license field.
java.util.List<PackageName>	packages	The names of the repository's source packages
static Name	PACKAGES	Name of the hydra.build.format.RepositoryDescriptor.packages field.
static Name	TYPE_	Name of the hydra.build.format.RepositoryDescriptor type.
java.lang.String	url	The URL of the project
static Name	URL	Name of the hydra.build.format.RepositoryDescriptor.url field.

Constructor Summary

Constructors

Constructor	Description
RepositoryDescriptor(Version currentVersion, Version hostVersion, java.util.Map<LanguageName,HostOverride> hostOverrides, java.lang.String group, java.lang.String author, java.lang.String url, java.lang.String license, java.util.List<PackageName> packages)	Constructs an immutable RepositoryDescriptor.

Method Summary

Modifier and Type	Method	Description
static RepositoryDescriptor.Builder	builder()	Creates a new fluent builder for RepositoryDescriptor.
int	compareTo(RepositoryDescriptor other)
boolean	equals(java.lang.Object other)
int	hashCode()
java.lang.String	toString()
RepositoryDescriptor	withAuthor(java.lang.String author)	Returns a copy of this RepositoryDescriptor with author replaced.
RepositoryDescriptor	withCurrentVersion(Version currentVersion)	Returns a copy of this RepositoryDescriptor with currentVersion replaced.
RepositoryDescriptor	withGroup(java.lang.String group)	Returns a copy of this RepositoryDescriptor with group replaced.
RepositoryDescriptor	withHostOverrides(java.util.Map<LanguageName,HostOverride> hostOverrides)	Returns a copy of this RepositoryDescriptor with hostOverrides replaced.
RepositoryDescriptor	withHostVersion(Version hostVersion)	Returns a copy of this RepositoryDescriptor with hostVersion replaced.
RepositoryDescriptor	withLicense(java.lang.String license)	Returns a copy of this RepositoryDescriptor with license replaced.
RepositoryDescriptor	withPackages(java.util.List<PackageName> packages)	Returns a copy of this RepositoryDescriptor with packages replaced.
RepositoryDescriptor	withUrl(java.lang.String url)	Returns a copy of this RepositoryDescriptor with url replaced.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_

public static final Name TYPE_

Name of the hydra.build.format.RepositoryDescriptor type.

CURRENT_VERSION

public static final Name CURRENT_VERSION

Name of the hydra.build.format.RepositoryDescriptor.currentVersion field.

HOST_VERSION

public static final Name HOST_VERSION

Name of the hydra.build.format.RepositoryDescriptor.hostVersion field.

HOST_OVERRIDES

public static final Name HOST_OVERRIDES

Name of the hydra.build.format.RepositoryDescriptor.hostOverrides field.

GROUP

public static final Name GROUP

Name of the hydra.build.format.RepositoryDescriptor.group field.

AUTHOR

public static final Name AUTHOR

Name of the hydra.build.format.RepositoryDescriptor.author field.

URL

public static final Name URL

Name of the hydra.build.format.RepositoryDescriptor.url field.

LICENSE

public static final Name LICENSE

Name of the hydra.build.format.RepositoryDescriptor.license field.

PACKAGES

public static final Name PACKAGES

Name of the hydra.build.format.RepositoryDescriptor.packages field.

currentVersion

public final Version currentVersion

The version currently under development

hostVersion

public final Version hostVersion

The published host version consumed by default when generating code

hostOverrides

public final java.util.Map<LanguageName,HostOverride> hostOverrides

Per-host-language overrides of the default published-host consumption

group

public final java.lang.String group

The group identifier under which artifacts are published, e.g. a Maven group id

author

public final java.lang.String author

The author attribution for published artifacts

url

public final java.lang.String url

The URL of the project

license

public final java.lang.String license

The license identifier for published artifacts, e.g. "Apache-2.0"

packages

public final java.util.List<PackageName> packages

The names of the repository's source packages

Constructor Detail

RepositoryDescriptor

public RepositoryDescriptor(Version currentVersion,
                            Version hostVersion,
                            java.util.Map<LanguageName,HostOverride> hostOverrides,
                            java.lang.String group,
                            java.lang.String author,
                            java.lang.String url,
                            java.lang.String license,
                            java.util.List<PackageName> packages)

Constructs an immutable RepositoryDescriptor.

Parameters:

currentVersion - The version currently under development

hostVersion - The published host version consumed by default when generating code

hostOverrides - Per-host-language overrides of the default published-host consumption

group - The group identifier under which artifacts are published, e.g. a Maven group id

author - The author attribution for published artifacts

url - The URL of the project

license - The license identifier for published artifacts, e.g. "Apache-2.0"

packages - The names of the repository's source packages

Method Detail

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(RepositoryDescriptor other)

Specified by:

compareTo in interface java.lang.Comparable<RepositoryDescriptor>

withCurrentVersion

public RepositoryDescriptor withCurrentVersion(Version currentVersion)

Returns a copy of this RepositoryDescriptor with currentVersion replaced.

withHostVersion

public RepositoryDescriptor withHostVersion(Version hostVersion)

Returns a copy of this RepositoryDescriptor with hostVersion replaced.

withHostOverrides

public RepositoryDescriptor withHostOverrides(java.util.Map<LanguageName,HostOverride> hostOverrides)

Returns a copy of this RepositoryDescriptor with hostOverrides replaced.

withGroup

public RepositoryDescriptor withGroup(java.lang.String group)

Returns a copy of this RepositoryDescriptor with group replaced.

withAuthor

public RepositoryDescriptor withAuthor(java.lang.String author)

Returns a copy of this RepositoryDescriptor with author replaced.

withUrl

public RepositoryDescriptor withUrl(java.lang.String url)

Returns a copy of this RepositoryDescriptor with url replaced.

withLicense

public RepositoryDescriptor withLicense(java.lang.String license)

Returns a copy of this RepositoryDescriptor with license replaced.

withPackages

public RepositoryDescriptor withPackages(java.util.List<PackageName> packages)

Returns a copy of this RepositoryDescriptor with packages replaced.

builder

public static RepositoryDescriptor.Builder builder()

Creates a new fluent builder for RepositoryDescriptor.