Module aya.cli.impl

Package org.aya.cli.library.json

Record Class LibraryConfig

java.lang.Object

java.lang.Record

org.aya.cli.library.json.LibraryConfig

public record LibraryConfig(@NotNull org.aya.util.Version ayaVersion, @NotNull String name, @NotNull String version, @NotNull Path libraryRoot, @NotNull Path librarySrcRoot, @NotNull Path libraryBuildRoot, @NotNull Path libraryOutRoot, @NotNull LibraryConfig.LibraryLiterateConfig literateConfig, @NotNull kala.collection.immutable.ImmutableSeq<LibraryDependency> deps)
extends Record

The compiler aspect of library description file, with generated settings.

Implementation Note:

issue #491

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	LibraryConfig.LibraryLiterateConfig

Constructor Summary

Constructors

Constructor	Description
LibraryConfig(@NotNull org.aya.util.Version ayaVersion, @NotNull String name, @NotNull String version, @NotNull Path libraryRoot, @NotNull Path librarySrcRoot, @NotNull Path libraryBuildRoot, @NotNull Path libraryOutRoot, @NotNull LibraryConfig.LibraryLiterateConfig literateConfig, @NotNull kala.collection.immutable.ImmutableSeq<LibraryDependency> deps)	Creates an instance of a LibraryConfig record class.

Method Summary

Modifier and Type	Method	Description
@NotNull org.aya.util.Version	ayaVersion()	Returns the value of the ayaVersion record component.
@NotNull kala.collection.immutable.ImmutableSeq<LibraryDependency>	deps()	Returns the value of the deps record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@NotNull Path	libraryBuildRoot()	Returns the value of the libraryBuildRoot record component.
@NotNull Path	libraryOutRoot()	Returns the value of the libraryOutRoot record component.
@NotNull Path	libraryRoot()	Returns the value of the libraryRoot record component.
@NotNull Path	librarySrcRoot()	Returns the value of the librarySrcRoot record component.
@NotNull LibraryConfig.LibraryLiterateConfig	literateConfig()	Returns the value of the literateConfig record component.
@NotNull String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.
@NotNull String	version()	Returns the value of the version record component.

Methods inherited from class java.lang.Object

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

Constructor Details

LibraryConfig

public LibraryConfig(@NotNull
 @NotNull org.aya.util.Version ayaVersion,
 @NotNull
 @NotNull String name,
 @NotNull
 @NotNull String version,
 @NotNull
 @NotNull Path libraryRoot,
 @NotNull
 @NotNull Path librarySrcRoot,
 @NotNull
 @NotNull Path libraryBuildRoot,
 @NotNull
 @NotNull Path libraryOutRoot,
 @NotNull
 @NotNull LibraryConfig.LibraryLiterateConfig literateConfig,
 @NotNull
 @NotNull kala.collection.immutable.ImmutableSeq<LibraryDependency> deps)

Creates an instance of a LibraryConfig record class.

Parameters:

ayaVersion - the value for the ayaVersion record component

name - the value for the name record component

version - the value for the version record component

libraryRoot - the value for the libraryRoot record component

librarySrcRoot - the value for the librarySrcRoot record component

libraryBuildRoot - the value for the libraryBuildRoot record component

libraryOutRoot - the value for the libraryOutRoot record component

literateConfig - the value for the literateConfig record component

deps - the value for the deps record component

Method Details

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.

ayaVersion

@NotNull
public @NotNull org.aya.util.Version ayaVersion()

Returns the value of the ayaVersion record component.

Returns:

the value of the ayaVersion record component

name

@NotNull
public @NotNull String name()

Returns the value of the name record component.

Returns:

the value of the name record component

version

@NotNull
public @NotNull String version()

Returns the value of the version record component.

Returns:

the value of the version record component

libraryRoot

@NotNull
public @NotNull Path libraryRoot()

Returns the value of the libraryRoot record component.

Returns:

the value of the libraryRoot record component

librarySrcRoot

@NotNull
public @NotNull Path librarySrcRoot()

Returns the value of the librarySrcRoot record component.

Returns:

the value of the librarySrcRoot record component

libraryBuildRoot

@NotNull
public @NotNull Path libraryBuildRoot()

Returns the value of the libraryBuildRoot record component.

Returns:

the value of the libraryBuildRoot record component

libraryOutRoot

@NotNull
public @NotNull Path libraryOutRoot()

Returns the value of the libraryOutRoot record component.

Returns:

the value of the libraryOutRoot record component

literateConfig

@NotNull
public @NotNull LibraryConfig.LibraryLiterateConfig literateConfig()

Returns the value of the literateConfig record component.

Returns:

the value of the literateConfig record component

deps

@NotNull
public @NotNull kala.collection.immutable.ImmutableSeq<LibraryDependency> deps()

Returns the value of the deps record component.

Returns:

the value of the deps record component