aboutlibraries-core/com.mikepenz.aboutlibraries.entity

Package-level declarations

Types

data class Developer(val name: String?, val organisationUrl: String?)

Describes the Developer defined in the pom.xml file.

data class Funding(val platform: String, val url: String)

Describes the Funding as defined by the dependency. This is only supported for projects hosted for dependencies hosted on: https://github.com/mikepenz/AboutLibraries#special-repository-support Or can be manually supplied.

Library

data class Library(val uniqueId: String, val artifactVersion: String?, val name: String, val description: String?, val website: String?, val developers: List<Developer>, val organization: Organization?, val scm: Scm?, val licenses: Set<License> = emptySet(), val funding: Set<Funding> = emptySet(), val tag: String? = null)

Describes a complete Library element, specifying important information about a used dependency.

License

data class License(val name: String, val url: String?, val year: String? = null, val spdxId: String? = null, val licenseContent: String? = null, val hash: String)

Describes a complete License element. Either retrieved from spdx or downloaded from the artifacts repo

Organization

data class Organization(val name: String, val url: String?)

Describes the Organization defined in the pom.xml file.

Scm

data class Scm(val connection: String?, val developerConnection: String?, val url: String?)

Describes the Scm defined in the pom.xml file.

SpdxLicense

enum SpdxLicense : Enum<SpdxLicense>

SpdxLicense includes all known licenses according to spdx.org Licenses found in the pom.xml are tried to be mapped against the spdx form for a consistet representation.