core/src/commonMain/kotlin/LicenseInfoRepository.kt
author Da Risk <da_risk@geekorum.com>
Sat, 01 Nov 2025 00:27:00 -0400
changeset 112 b2032db61006
parent 34 ce299aacc068
permissions -rw-r--r--
build: update project version to 0.2.2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
26
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     1
/*
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     2
 * AboutOss is an utility library to retrieve and display
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     3
 * opensource licenses in Android applications.
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     4
 *
34
ce299aacc068 build: update license headers
Da Risk <da_risk@geekorum.com>
parents: 26
diff changeset
     5
 * Copyright (C) 2023-2025 by Frederic-Charles Barthelery.
26
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     6
 *
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     7
 * This file is part of AboutOss.
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     8
 *
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     9
 * AboutOss is free software: you can redistribute it and/or modify
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    10
 * it under the terms of the GNU General Public License as published by
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    11
 * the Free Software Foundation, either version 3 of the License, or
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    12
 * (at your option) any later version.
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    13
 *
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    14
 * AboutOss is distributed in the hope that it will be useful,
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    15
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    17
 * GNU General Public License for more details.
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    18
 *
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    19
 * You should have received a copy of the GNU General Public License
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    20
 * along with AboutOss.  If not, see <http://www.gnu.org/licenses/>.
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    21
 */
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    22
package com.geekorum.aboutoss.core
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    23
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    24
/**
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    25
 * Retrieve License information 
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    26
 */
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    27
interface LicenseInfoRepository {
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    28
    /**
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    29
     * Get a map of license text per dependency
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    30
     */
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    31
    suspend fun getLicensesInfo(): Map<String, String>
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    32
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    33
    /**
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    34
     * Get license text for a specific dependency
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    35
     */
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    36
    suspend fun getLicenseFor(dependency: String): String
59006722b704 core: extract LicenseInfoRepository interface
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    37
}