org.apache.maven.shared.utils.logging.package-info Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-surefire-common Show documentation
Show all versions of maven-surefire-common Show documentation
API used in Surefire and Failsafe MOJO.
// CHECKSTYLE_OFF: RegexpHeader
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
/**
* An API to write Maven messages to console with styled color content, consistently across whole
* Maven ecosystem (Maven itself or any plugin or extension).
*
* Messages are built with instances of {@link org.apache.maven.shared.utils.logging.MessageBuilder MessageBuilder}
* which provides a fluent API.
* {@link org.apache.maven.shared.utils.logging.MessageUtils MessageUtils} gives access to these buffers.
*
* Plugins can use this API with any Maven version: color
* just won't be activated when run with Maven version older than 3.4.0.
*
* Styles are:
* debug
, info
, warning
and error
for slf4j level display,
* success
, warning
, failure
, strong
, mojo
* and project
for message content
*
* Default styles colors can be overridden through system properties, that can be set in MAVEN_OPTS
* environment variable (eventually in .mavenrc
script):
* - system properties are named
style.<style name>
,
* - values are comma separated combination of
bold
, <color>
and
* bg<color>
(for background), where <color>
is
* an ANSI color: black
,
* red
, green
, yellow
, blue
, magenta
,
* cyan
or white
, eventually with bright
prefix
*
*/
package org.apache.maven.shared.utils.logging;