Module com.github.sormuras.bach

Package com.github.sormuras.bach

Record Class Grabber

java.lang.Object

java.lang.Record

com.github.sormuras.bach.Grabber

public record Grabber(Bach bach, ExternalModuleLocators locators)
extends Record

A grabber helps loading, updating, and verifying external assets.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Grabber.Asset	Links a local file via its path name to a (remote) resource identifier.
static final record	Grabber.Directory	Links an Grabber.Asset list to a directory name within a parent directory.

Constructor Summary

Constructors

Constructor	Description
Grabber(Bach bach, ExternalModuleLocators locators)	Creates an instance of a Grabber record class.

Method Summary

Modifier and Type	Method	Description
Bach	bach()	Returns the value of the bach record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
void	grab(Grabber.Directory... directories)
void	grab(Path directory, Grabber.Asset asset)
void	grabExternalModules(Iterable<String> modules)
void	grabExternalModules(String... modules)
void	grabMissingExternalModules()
final int	hashCode()	Returns a hash code value for this object.
ExternalModuleLocators	locators()	Returns the value of the locators record component.
Grabber.Directory	newExternalToolLayerDirectory(String name, Grabber.Asset... assets)
Grabber.Directory	newExternalToolProgramDirectory(String name, Grabber.Asset... assets)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Grabber

public Grabber(Bach bach,
 ExternalModuleLocators locators)

Creates an instance of a Grabber record class.

Parameters:

bach - the value for the bach record component

locators - the value for the locators record component

Method Details

newExternalToolLayerDirectory

public Grabber.Directory newExternalToolLayerDirectory(String name,
 Grabber.Asset... assets)

newExternalToolProgramDirectory

public Grabber.Directory newExternalToolProgramDirectory(String name,
 Grabber.Asset... assets)

grab

public void grab(Path directory,
 Grabber.Asset asset)

grab

public void grab(Grabber.Directory... directories)

grabExternalModules

public void grabExternalModules(String... modules)

grabExternalModules

public void grabExternalModules(Iterable<String> modules)

grabMissingExternalModules

public void grabMissingExternalModules()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

bach

public Bach bach()

Returns the value of the bach record component.

Returns:

the value of the bach record component

locators

public ExternalModuleLocators locators()

Returns the value of the locators record component.

Returns:

the value of the locators record component