/*
 * Copyright (c) 2012-2017 The ANTLR Project. All rights reserved.
 * Use of this file is governed by the BSD 3-clause license that
 * can be found in the LICENSE.txt file in the project root.
 */
package org.antlr.v4.tool;

Abstracts away the definition of Message severity and the text that should
display to represent that severity if there is no StringTemplate available
to do it.
Author:
Jim Idle - Temporal Wave LLC (jimi@temporal-wave.com)/**
 * Abstracts away the definition of Message severity and the text that should
 * display to represent that severity if there is no StringTemplate available
 * to do it.
 *
 * @author Jim Idle - Temporal Wave LLC (jimi@temporal-wave.com)
 */
public enum ErrorSeverity {
    INFO    ("info"),
	WARNING ("warning"),
	WARNING_ONE_OFF ("warning"),
	ERROR   ("error"),
	ERROR_ONE_OFF   ("error"),
    FATAL   ("fatal"),  // TODO: add fatal for which phase? sync with ErrorManager
    ;

    
The text version of the ENUM value, used for display purposes
/**
     * The text version of the ENUM value, used for display purposes
     */
    private final String text;

    
Standard getter method for the text that should be displayed in order to
represent the severity to humans and product modelers.
Returns:
The human readable string representing the severity level/**
     * Standard getter method for the text that should be displayed in order to
     * represent the severity to humans and product modelers.
     *
     * @return The human readable string representing the severity level
     */
    public String getText() { return text; }

    
Standard constructor to build an instance of the Enum entries
Params:
text – The human readable string representing the severity level/**
     * Standard constructor to build an instance of the Enum entries
     *
     * @param text The human readable string representing the severity level
     */
    private ErrorSeverity(String text) { this.text = text; }
}