Module org.basinmc.lavatory

Package org.basinmc.lavatory

Class Manifest

java.lang.Object

org.basinmc.lavatory.Manifest

public final class Manifest
extends Object

Represents a loaded version manifest which lists every available game version, their release date, modification time, type and manifest url as well as the latest available version for the two currently available release types (release and snapshot).

Author:

Johannes Donath

Field Summary

Fields

Modifier and Type	Field	Description
static String	MANIFEST_URL	Defines the default location from which this manifest can typically be retrieved.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Manifest(Map<String,String> latestVersions, Set<VersionReference> references)
	Manifest(VersionReference latestStable, VersionReference latestSnapshot, Map<String,VersionReference> versionMap)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static Manifest	fetch()	Fetches the current version manifest from the servers.
VersionReference	getLatestSnapshot()	Retrieves an excerpt of the latest snapshot version.
VersionReference	getLatestStable()	Retrieves an excerpt of the latest stable version.
Optional<VersionReference>	getVersion(String versionId)	Retrieves an excerpt of a specific version (if known).
Set<VersionReference>	getVersions()	Retrieves a set of available versions (and their respective excerpts).
int	hashCode()
static Manifest	read(InputStream inputStream)	Decodes a launcher version manifest from the specified input stream.
static Manifest	read(Reader reader)	Decodes a launcher version manifest from the specified reader.
static Manifest	read(Path path)	Decodes a launcher version manifest from the specified file.

Methods inherited from class java.lang.Object

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

Field Detail

MANIFEST_URL

public static final String MANIFEST_URL

Defines the default location from which this manifest can typically be retrieved.

See Also:

Constant Field Values

Constructor Detail

Manifest

public Manifest(@NonNull
                VersionReference latestStable,
                @NonNull
                VersionReference latestSnapshot,
                @NonNull
                Map<String,VersionReference> versionMap)

Manifest

protected Manifest(@NonNull
                   Map<String,String> latestVersions,
                   @NonNull
                   Set<VersionReference> references)

Method Detail

fetch

@NonNull
public static Manifest fetch()
                      throws IOException

Fetches the current version manifest from the servers.

Returns:

a manifest.

Throws:

IOException - when the server response is invalid (e.g. when any type of error code is sent), no connection can be established or the data is malformed.

getLatestStable

@NonNull
public VersionReference getLatestStable()

Retrieves an excerpt of the latest stable version.

Returns:

a version excerpt.

getLatestSnapshot

@NonNull
public VersionReference getLatestSnapshot()

Retrieves an excerpt of the latest snapshot version.

Returns:

a version excerpt.

getVersion

@NonNull
public Optional<VersionReference> getVersion(@NonNull
                                             String versionId)

Retrieves an excerpt of a specific version (if known).

Parameters:

versionId - a version identifier.

Returns:

a version excerpt or an empty optional if no such version is available.

getVersions

@NonNull
public Set<VersionReference> getVersions()

Retrieves a set of available versions (and their respective excerpts).

Returns:

a set of version excerpts.

read

@NonNull
public static Manifest read(@NonNull
                            InputStream inputStream)
                     throws IOException

Decodes a launcher version manifest from the specified input stream.

Parameters:

inputStream - an input stream.

Returns:

a version manifest.

Throws:

IOException - when reading from the input stream fails or the data is malformed.

read

@NonNull
public static Manifest read(@NonNull
                            Path path)
                     throws IOException

Decodes a launcher version manifest from the specified file.

Parameters:

path - a file path.

Returns:

a version manifest.

Throws:

IOException - when reading from the file fails or the data is malformed.

read

@NonNull
public static Manifest read(@NonNull
                            Reader reader)
                     throws IOException

Decodes a launcher version manifest from the specified reader.

Parameters:

reader - a reader.

Returns:

a version manifest.

Throws:

IOException - when reading from the file fails or the data is malformed.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object