Quilt Loader 1
Loading...
Searching...
No Matches
org.quiltmc.loader.api.ModLicense Interface Reference

Representation of a license a mod may use. More...

Inheritance diagram for org.quiltmc.loader.api.ModLicense:
org.quiltmc.loader.impl.metadata.qmj.ModLicenseImpl

Public Member Functions

String name ()
String id ()
String url ()
String description ()

Static Public Member Functions

static ModLicense fromIdentifier (String identifier)
 Looks up a ModLicense from the given SPDX license ID, returning null if quilt-loader is unaware of it.
static ModLicense fromIdentifierOrDefault (String identifier)
 Looks up a ModLicense from the given SPDX license ID, returning a new ModLicense (with name() and id() set to the passed identifier, the other fields blank) if quilt-loader is unaware of it.

Detailed Description

Representation of a license a mod may use.

See also
SPDX identifier

Member Function Documentation

◆ description()

String org.quiltmc.loader.api.ModLicense.description ( )
Returns
a short description of the license, empty if there is no description

Implemented in org.quiltmc.loader.impl.metadata.qmj.ModLicenseImpl.

◆ fromIdentifier()

ModLicense org.quiltmc.loader.api.ModLicense.fromIdentifier ( String identifier)
inlinestatic

Looks up a ModLicense from the given SPDX license ID, returning null if quilt-loader is unaware of it.

Implemented in org.quiltmc.loader.impl.metadata.qmj.ModLicenseImpl.

◆ fromIdentifierOrDefault()

ModLicense org.quiltmc.loader.api.ModLicense.fromIdentifierOrDefault ( String identifier)
inlinestatic

Looks up a ModLicense from the given SPDX license ID, returning a new ModLicense (with name() and id() set to the passed identifier, the other fields blank) if quilt-loader is unaware of it.

Implemented in org.quiltmc.loader.impl.metadata.qmj.ModLicenseImpl.

◆ id()

String org.quiltmc.loader.api.ModLicense.id ( )
Returns
the short identifier of the license, typically an SPDX identifier

Implemented in org.quiltmc.loader.impl.metadata.qmj.ModLicenseImpl.

◆ name()

String org.quiltmc.loader.api.ModLicense.name ( )
Returns
the name of the license

Implemented in org.quiltmc.loader.impl.metadata.qmj.ModLicenseImpl.

◆ url()

String org.quiltmc.loader.api.ModLicense.url ( )
Returns
the url to view the text of the license. May be empty.

Implemented in org.quiltmc.loader.impl.metadata.qmj.ModLicenseImpl.


The documentation for this interface was generated from the following file:
  • src/main/java/org/quiltmc/loader/api/ModLicense.java