commonMain.com.mikepenz.aboutlibraries.entity.License.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aboutlibraries-core Show documentation

AboutLibraries automatically detects all dependencies of a project and collects their information including the license. Optionally visualising it via the provided ui components.

The newest version!

package com.mikepenz.aboutlibraries.entity

import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable

/**
 * Describes a complete [License] element.
 * Either retrieved from spdx or downloaded from the artifacts repo
 *
 * @param name of the given license
 * @param url linking to the hosted form of this license
 * @param year if available for this license (not contained in the `pom.xml`)
 * @param spdxId for this library, if it is a standard library available
 * @param licenseContent contains the whole license content as downloaded from the server
 * @param hash usually calculated to identify if a license is re-used and can be used for multiple artifacts
 */
@Serializable
data class License(
    @SerialName("name") val name: String,
    @SerialName("url") val url: String?,
    @SerialName("year") val year: String? = null,
    @SerialName("spdxId") val spdxId: String? = null,
    @SerialName("licenseContent") val licenseContent: String? = null,
    @SerialName("hash") val hash: String
) {
    override fun equals(other: Any?): Boolean {
        if (this === other) return true
        if (other == null || this::class != other::class) return false

        other as License

        if (hash != other.hash) return false

        return true
    }

    override fun hashCode(): Int {
        return hash.hashCode()
    }
}