com.microsoft.thrifty.schema.ErrorReporter.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of thrifty-schema Show documentation
A simple Thrift IDL parser and validator
There is a newer version: 3.1.0
/*
 * Thrifty
 *
 * Copyright (c) Microsoft Corporation
 *
 * All rights reserved.
 *
 * 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
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * THIS CODE IS PROVIDED ON AN  *AS IS* BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING
 * WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE,
 * FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT.
 *
 * See the Apache Version 2.0 License for specific language governing permissions and limitations under the License.
 */
package com.microsoft.thrifty.schema

/**
 * An object that can collect warning and error reports generated during
 * parsing and schema validation.
 */
class ErrorReporter {
    /**
     * True if this reporter contains error-level reports.
     */
    var hasError = false
        private set

    private val reports_: MutableList = mutableListOf()

    /**
     * All reports collected by this reporter.
     */
    val reports: List
        get() = reports_

    /**
     * Reports a warning at the given [location].
     */
    fun warn(location: Location, message: String) {
        reports_.add(Report(Level.WARNING, location, message))
    }

    /**
     * Reports an error at the given [location].
     */
    fun error(location: Location, message: String) {
        hasError = true
        reports_.add(Report(Level.ERROR, location, message))
    }

    /**
     * Returns a list of formatted warning and error reports contained in this
     * reporter.
     */
    fun formattedReports(): List {
        val list = mutableListOf()
        val sb = StringBuilder()
        for (report in reports_) {
            when (report.level) {
                ErrorReporter.Level.WARNING -> sb.append("W: ")
                ErrorReporter.Level.ERROR -> sb.append("E: ")
            }

            sb.append(report.message)
            sb.append(" (at ")
            sb.append(report.location)
            sb.append(")")

            list += sb.toString()

            sb.setLength(0)
        }
        return list
    }

    /**
     * A structure containing a report level, content, and location.
     *
     * @property level The severity of the report.
     * @property location The point in a .thrift file containing the subject of the report.
     * @property message A description of the warning or error condition.
     */
    data class Report(
            val level: Level,
            val location: Location,
            val message: String
    )

    /**
     * The severities of reports.
     */
    enum class Level {
        /**
         * A warning is non-fatal, but should be investigated.
         */
        WARNING,

        /**
         * An error indicates that loading cannot proceed.
         */
        ERROR
    }
}