com.societegenerale.githubcrawler.parsers.FileContentParser.kt Maven / Gradle / Ivy

Go to download

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

There is a newer version: 2.2.0

package com.societegenerale.githubcrawler.parsers

import com.societegenerale.githubcrawler.IndicatorDefinition


/**
 * A parser that takes a given file content as a parameter, and returns the values that we're looking for. Implementation will typically define a
 * couple of configuration parameter that are required to perform its duty. See how [PomXmlParserForDependencyVersion] defines and uses [PomXmlParserForDependencyVersion.ARTIFACT_ID] for instance
 */
interface FileContentParser {

    /**
     * @return the parser's ID that we need to use in config to refer to it. Typically, a String describing the parser type.
     * At application startup, beans implementing the interface will be instantiated and stored in a Map as a value, with getNameInConfig value as the key.
     */
    fun getNameInConfig(): String

    /**
     * @param fileContent the file content that needs to be parsed
     * @param pathToFileToGetIndicatorsFrom the path to the file. Rarely used, but sometimes useful, like in [SimpleFilePathParser]
     * @param kpi the indicator we need to find in the file
     * @return a Map with the indicator name as key, and the value found as the value. Most of the time, the map will have a single entry.
     */
    fun parseFileContentForIndicator(fileContent: String, pathToFileToGetIndicatorsFrom:String, kpi: IndicatorDefinition): Map


    companion object {
        val NOT_FOUND = "not found"
    }
}