toolkit.model.33.1.0.source-code.VcsType.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of model Show documentation
Part of the OSS Review Toolkit (ORT), a suite to automate software compliance checks.
The 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.model

import com.fasterxml.jackson.annotation.JsonCreator
import com.fasterxml.jackson.annotation.JsonValue

/**
 * A class for Version Control System types. Each type has one or more [aliases] associated to it, where the first
 * alias is the definite name. This class is not implemented as an enum as constructing from an unknown type should be
 * supported while maintaining that type as the primary alias for the string representation.
 */
data class VcsType private constructor(private val aliases: List) {
    /**
     * A constructor that takes a [name] in addition to a variable number of other [aliases] to enforce a non-empty list
     * of final aliases.
     */
    constructor(name: String, vararg aliases: String) : this(listOf(name, *aliases))

    companion object {
        /**
         * [Git](https://git-scm.com/) - the stupid content tracker.
         */
        val GIT = VcsType("Git")

        /**
         * [Repo](https://source.android.com/setup/develop/repo) complements Git by simplifying work across multiple
         * repositories.
         */
        val GIT_REPO = VcsType("GitRepo", "git-repo", "repo")

        /**
         * [Mercurial](https://www.mercurial-scm.org/) is a free, distributed source control management tool.
         */
        val MERCURIAL = VcsType("Mercurial", "hg")

        /**
         * [Subversion](https://subversion.apache.org/) is an open source Version Control System.
         */
        val SUBVERSION = VcsType("Subversion", "svn")

        /**
         * An unknown VCS type.
         */
        val UNKNOWN = VcsType("")

        private val KNOWN_TYPES = setOf(GIT, GIT_REPO, MERCURIAL, SUBVERSION)

        /**
         * Search all [known VCS types][KNOWN_TYPES] for being associated with given [name] return the first matching
         * type, or create a new [VcsType] with the given [name] if no known type matches.
         */
        @JsonCreator(mode = JsonCreator.Mode.DELEGATING)
        @JvmStatic
        fun forName(name: String): VcsType =
            KNOWN_TYPES.find { type ->
                type.aliases.any { it.equals(name, ignoreCase = true) }
            } ?: VcsType(name)
    }

    @JsonValue
    override fun toString(): String = aliases.first()
}