toolkit.utils.common-utils.33.0.0.source-code.FileMatcher.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common-utils Show documentation

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

There is a newer version: 41.0.0

/*
 * 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.utils.common

import org.springframework.util.AntPathMatcher

/**
 * A class to determine whether a path is matched by any of the given globs.
 */
class FileMatcher(
    /**
     * The collection of [glob patterns][1] to consider for matching.
     *
     * [1]: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/util/AntPathMatcher.html
     */
    val patterns: Collection,

    /**
     * Toggle the case-sensitivity of the matching.
     */
    ignoreCase: Boolean = false
) {
    constructor(vararg patterns: String, ignoreCase: Boolean = false) : this(patterns.asList(), ignoreCase)

    companion object {
        private val matchCaseInsensitive = AntPathMatcher().apply { setCaseSensitive(false) }::match
        private val matchCaseSensitive = AntPathMatcher().apply { setCaseSensitive(true) }::match

        /**
         * Return true if [path] is matched by [pattern], false otherwise. The [path] must use '/' as separators, if it
         * contains any.
         */
        fun match(pattern: String, path: String, ignoreCase: Boolean = false) =
            when (ignoreCase) {
                true -> matchCaseInsensitive(pattern, path)
                false -> matchCaseSensitive(pattern, path)
            }

        /**
         * Return true if [path] is matched by any of [patterns], false otherwise. The [path] must use '/' as
         * separators, if it contains any.
         */
        fun match(patterns: Collection, path: String, ignoreCase: Boolean = false) =
            when (ignoreCase) {
                true -> patterns.any { pattern -> matchCaseInsensitive(pattern, path) }
                false -> patterns.any { pattern -> matchCaseSensitive(pattern, path) }
            }
    }

    private val match = if (ignoreCase) matchCaseInsensitive else matchCaseSensitive

    /**
     * Return true if [path] is matched by any of [patterns], false otherwise. The [path] must use '/' as separators,
     * if it contains any.
     */
    fun matches(path: String): Boolean = patterns.any { pattern -> match(pattern, path) }
}