Module org.basinmc.lavatory

Package org.basinmc.lavatory.asset

Class AssetIndexReference

java.lang.Object

org.basinmc.lavatory.file.Download

org.basinmc.lavatory.asset.AssetIndexReference

public class AssetIndexReference
extends Download

Represents a reference to an asset index which effectively identifies where to retrieve game assets from.

Author:

Johannes Donath

Field Summary

Fields inherited from class org.basinmc.lavatory.file.Download

CHECKSUM_ALGORITHM

Constructor Summary

Constructors

Constructor	Description
AssetIndexReference(String id, String sha1, long size, URL url, long totalSize)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
AssetIndex	fetch()	Fetches the full asset index from the server and parses its contents.
String	getId()	Retrieves a globally unique identifier for this asset index.
long	getTotalSize()	Retrieves the combined size for all files within the asset index (in bytes).
int	hashCode()

Methods inherited from class org.basinmc.lavatory.file.Download

fetch, getSha1, getSha1Bytes, getSize, getUrl, verify

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetIndexReference

public AssetIndexReference(@NonNull
                           String id,
                           @NonNull
                           String sha1,
                           long size,
                           @NonNull
                           URL url,
                           long totalSize)

Method Detail

fetch

@NonNull
public AssetIndex fetch()
                 throws IOException

Fetches the full asset index from the server and parses its contents.

Returns:

a parsed asset index.

Throws:

IOException - when the server is unreachable, responds with an error code or when the data is malformed.

getId

@NonNull
public String getId()

Retrieves a globally unique identifier for this asset index.

Returns:

an index.

getTotalSize

public long getTotalSize()

Retrieves the combined size for all files within the asset index (in bytes).

Returns:

the total size.

equals

public boolean equals(Object o)

Overrides:

equals in class Download

hashCode

public int hashCode()

Overrides:

hashCode in class Download