/*
 * JBoss, Home of Professional Open Source
 * Copyright 2018, Red Hat, Inc., and individual contributors as indicated
 * by the @authors tag.
 *
 * 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
 *
 * 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.
 */

package org.jboss.as.cli;

import org.aesh.readline.terminal.formatting.Color;

/**
 * A representation of the CLI color configuration
 * @author <a href="ingo@redhat.com">Ingo Weiss</a>
 */
public interface ColorConfig {
    /**
     * @return If color output if desired
     */
    boolean isEnabled();

    /**
     * @return The color of error messages
     */
    Color getErrorColor();

    /**
     * @return The color of warning messages
     */
    Color getWarnColor();

    /**
     * @return The color of success messages
     */
    Color getSuccessColor();

    /**
     * @return The color of required autocompletion parameters
     */
    Color getRequiredColor();

    /**
     * @return The color of batch and workflow prompts
     */
    Color getWorkflowColor();

    /**
     * @return The color of the prompt
     */
    Color getPromptColor();
}
