toolkit.plugins.reporters.evaluated-model-reporter.41.0.0.source-code.EvaluatedPackage.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of evaluated-model-reporter Show documentation

Part of the OSS Review Toolkit (ORT), a suite to automate software compliance checks.

There is a newer version: 46.0.0

Show newest version

/*
 * Copyright (C) 2017 The ORT Project Authors (see )
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * License-Filename: LICENSE
 */

package org.ossreviewtoolkit.plugins.reporters.evaluatedmodel

import com.fasterxml.jackson.annotation.JsonIdentityReference
import com.fasterxml.jackson.annotation.JsonInclude

import java.util.SortedSet

import org.ossreviewtoolkit.model.Identifier
import org.ossreviewtoolkit.model.Package
import org.ossreviewtoolkit.model.PackageCurationResult
import org.ossreviewtoolkit.model.RemoteArtifact
import org.ossreviewtoolkit.model.VcsInfo
import org.ossreviewtoolkit.model.config.PathExclude
import org.ossreviewtoolkit.model.config.ScopeExclude
import org.ossreviewtoolkit.utils.spdx.SpdxExpression

/**
 * The evaluated form of a [Package] used by the [EvaluatedModel].
 */
data class EvaluatedPackage(
    val id: Identifier,
    val isProject: Boolean,
    val definitionFilePath: String,
    @JsonInclude(JsonInclude.Include.NON_NULL)
    val purl: String? = null,
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    val authors: Set,
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    val declaredLicenses: List,
    val declaredLicensesProcessed: EvaluatedProcessedDeclaredLicense,
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    val detectedLicenses: Set,
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    val detectedExcludedLicenses: Set,
    @JsonInclude(JsonInclude.Include.NON_NULL)
    val concludedLicense: SpdxExpression? = null,
    @JsonInclude(JsonInclude.Include.NON_NULL)
    val effectiveLicense: SpdxExpression? = null,
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    val description: String,
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    val homepageUrl: String,
    val binaryArtifact: RemoteArtifact,
    val sourceArtifact: RemoteArtifact,
    val vcs: VcsInfo,
    val vcsProcessed: VcsInfo = vcs.normalize(),
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    val curations: List,
    @JsonIdentityReference(alwaysAsId = true)
    val paths: MutableList,
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    val levels: SortedSet,
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    val scopes: MutableSet,
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    val scanResults: List,
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    val findings: List,
    val isExcluded: Boolean,
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    val pathExcludes: List,
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    val scopeExcludes: List,
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    val issues: List
)