Module org.basinmc.lavatory

Package org.basinmc.lavatory.file

Class LibraryReference

java.lang.Object

org.basinmc.lavatory.rule.AbstractRuleControlledResource

org.basinmc.lavatory.file.LibraryReference

All Implemented Interfaces:

Comparable<LibraryReference>, RuleControlledResource

public class LibraryReference
extends AbstractRuleControlledResource
implements Comparable<LibraryReference>

Represents a reference to a library on which a game version depends as well as all of its respective classifiers.

Author:

Johannes Donath

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LibraryReference.DownloadMap	Provides a map of downloadable artifacts along with their classifiers.
static class	LibraryReference.ExtractionConfiguration	Represents an extraction configuration which identifies whether and how a library is to be extracted.

Constructor Summary

Constructors

Modifier	Constructor	Description
	LibraryReference(String name, LibraryArtifact linuxNativesArtifact, LibraryArtifact macNativesArtifact, LibraryArtifact windowsNativesArtifact, LibraryReference.DownloadMap downloads, LibraryReference.ExtractionConfiguration extractionConfiguration, Set<Rule> rules)
protected	LibraryReference(String name, LibraryReference.DownloadMap downloads, Map<String,String> classifierMap, LibraryReference.ExtractionConfiguration extractionConfiguration, Set<Rule> rules)

Method Summary

Modifier and Type	Method	Description
int	calculatePriority()	Calculates the priority of this reference.
int	compareTo(LibraryReference libraryReference)
boolean	equals(Object o)
LibraryReference.DownloadMap	getDownloads()	Retrieves a map of downloadable artifacts.
Optional<LibraryReference.ExtractionConfiguration>	getExtractionConfiguration()	Retrieves an extraction config which identifies whether and how the artifact is to be extracted.
Optional<LibraryArtifact>	getLinuxNativesArtifact()	Retrieves the artifact which contains the Linux natives for this particular library.
Optional<LibraryArtifact>	getMacNativesArtifact()	Retrieves the artifact which contains the Mac OS natives for this particular library.
String	getName()	Retrieves the identifier for this library reference (typically similarly formatted to a maven coordinate).
Optional<LibraryArtifact>	getWindowsNativesArtifact()	Retrieves the artifact which contains the Windows natives for this particular library.
int	hashCode()

Methods inherited from class org.basinmc.lavatory.rule.AbstractRuleControlledResource

evaluate, getRules

Methods inherited from class java.lang.Object

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

Constructor Detail

LibraryReference

public LibraryReference(@NonNull
                        String name,
                        @Nullable
                        LibraryArtifact linuxNativesArtifact,
                        @Nullable
                        LibraryArtifact macNativesArtifact,
                        @Nullable
                        LibraryArtifact windowsNativesArtifact,
                        @NonNull
                        LibraryReference.DownloadMap downloads,
                        @Nullable
                        LibraryReference.ExtractionConfiguration extractionConfiguration,
                        @Nullable
                        Set<Rule> rules)

LibraryReference

protected LibraryReference(@NonNull
                           String name,
                           @NonNull
                           LibraryReference.DownloadMap downloads,
                           @Nullable
                           Map<String,String> classifierMap,
                           @Nullable
                           LibraryReference.ExtractionConfiguration extractionConfiguration,
                           @Nullable
                           Set<Rule> rules)

Method Detail

calculatePriority

public int calculatePriority()

Calculates the priority of this reference.

This method effectively identifies the definition precision of a library reference in order to evaluate which of two or more possible elements to choose in order to get the most information when a duplicate exists.

While these duplicates typically occur in their correct order (probably due to the fact that older launcher versions will discord library versions they do not know how to deal with), we're still comparing them according to this method to avoid future issues.

Returns:

a priority (higher is better).

compareTo

public int compareTo(@NonNull
                     LibraryReference libraryReference)

Specified by:

compareTo in interface Comparable<LibraryReference>

getName

@NonNull
public String getName()

Retrieves the identifier for this library reference (typically similarly formatted to a maven coordinate).

Returns:

an identifier.

getLinuxNativesArtifact

@NonNull
public Optional<LibraryArtifact> getLinuxNativesArtifact()

Retrieves the artifact which contains the Linux natives for this particular library.

Returns:

an artifact or, if none is specified, an empty optional.

getMacNativesArtifact

@NonNull
public Optional<LibraryArtifact> getMacNativesArtifact()

Retrieves the artifact which contains the Mac OS natives for this particular library.

Returns:

an artifact or, if none is specified, an empty optional.

getWindowsNativesArtifact

@NonNull
public Optional<LibraryArtifact> getWindowsNativesArtifact()

Retrieves the artifact which contains the Windows natives for this particular library.

Returns:

an artifact or, if none is specified, an empty optional.

getDownloads

@NonNull
public LibraryReference.DownloadMap getDownloads()

Retrieves a map of downloadable artifacts.

Returns:

a download map.

getExtractionConfiguration

@NonNull
public Optional<LibraryReference.ExtractionConfiguration> getExtractionConfiguration()

Retrieves an extraction config which identifies whether and how the artifact is to be extracted.

Returns:

an extraction config or, if no extraction is desired, an empty optional.

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractRuleControlledResource

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractRuleControlledResource