Library

data class Library(uniqueId: String, artifactVersion: String?, name: String, description: String?, website: String?, developers: List<Developer>, organization: Organization?, scm: Scm?, licenses: Set<License>)

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

Parameters

uniqueId

describes this dependency (matches artifactId without version)

artifactVersion

the version of the artifact used

name

of the given dependency

description

of the given dependency, may be empty.

website

provided by the artifact pom.xml

developers

list, including all listed devs according to the pom file

organization

describing the creating org of for the dependency

scm

information, linking to the repository hosting the source

licenses

all identified licenses for this artifact

Constructors

Library
Link copied to clipboard
fun Library(uniqueId: String, artifactVersion: String?, name: String, description: String?, website: String?, developers: List<Developer>, organization: Organization?, scm: Scm?, licenses: Set<License> = emptySet())

Properties

artifactId
Link copied to clipboard
val artifactId: String

defines the uniqueId:artifactVersion combined

artifactVersion
Link copied to clipboard
val artifactVersion: String?
description
Link copied to clipboard
val description: String?
developers
Link copied to clipboard
val developers: List<Developer>
licenses
Link copied to clipboard
val licenses: Set<License>
name
Link copied to clipboard
val name: String
openSource
Link copied to clipboard
val openSource: Boolean

Returns true in cases this artifact is assumed to be open source (e..g. scm.url is provided)

organization
Link copied to clipboard
val organization: Organization?
scm
Link copied to clipboard
val scm: Scm?
uniqueId
Link copied to clipboard
val uniqueId: String
website
Link copied to clipboard
val website: String?