[MSHARED-562] API simplification
git-svn-id: https://svn.apache.org/repos/asf/maven/shared/trunk@1753133 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/maven/shared/utils/logging/AnsiMessageBuffer.java b/src/main/java/org/apache/maven/shared/utils/logging/AnsiMessageBuffer.java
index b3bc539..10893c9 100644
--- a/src/main/java/org/apache/maven/shared/utils/logging/AnsiMessageBuffer.java
+++ b/src/main/java/org/apache/maven/shared/utils/logging/AnsiMessageBuffer.java
@@ -50,93 +50,57 @@
this.ansi = ansi;
}
- public AnsiMessageBuffer debug()
+ public AnsiMessageBuffer debug( Object message )
{
- Style.DEBUG.apply( ansi );
+ Style.DEBUG.apply( ansi ).a( message ).reset();
return this;
}
- public AnsiMessageBuffer info()
+ public AnsiMessageBuffer info( Object message )
{
- Style.INFO.apply( ansi );
- return this;
- }
-
- public AnsiMessageBuffer warning()
- {
- Style.WARNING.apply( ansi );
+ Style.INFO.apply( ansi ).a( message ).reset();
return this;
}
public AnsiMessageBuffer warning( Object message )
{
- return warning().a( message ).reset();
- }
-
- public AnsiMessageBuffer error()
- {
- Style.ERROR.apply( ansi );
+ Style.WARNING.apply( ansi ).a( message ).reset();
return this;
}
- public AnsiMessageBuffer success()
+ public AnsiMessageBuffer error( Object message )
{
- Style.SUCCESS.apply( ansi );
+ Style.ERROR.apply( ansi ).a( message ).reset();
return this;
}
public AnsiMessageBuffer success( Object message )
{
- return success().a( message ).reset();
- }
-
- public AnsiMessageBuffer failure()
- {
- Style.FAILURE.apply( ansi );
+ Style.SUCCESS.apply( ansi ).a( message ).reset();
return this;
}
public AnsiMessageBuffer failure( Object message )
{
- return failure().a( message ).reset();
- }
-
- public AnsiMessageBuffer strong()
- {
- Style.STRONG.apply( ansi );
+ Style.FAILURE.apply( ansi ).a( message ).reset();
return this;
}
public AnsiMessageBuffer strong( Object message )
{
- return strong().a( message ).reset();
- }
-
- public AnsiMessageBuffer mojo()
- {
- Style.MOJO.apply( ansi );
+ Style.STRONG.apply( ansi ).a( message ).reset();
return this;
}
public AnsiMessageBuffer mojo( Object message )
{
- return mojo().a( message ).reset();
- }
-
-
- public AnsiMessageBuffer project()
- {
- Style.PROJECT.apply( ansi );
+ Style.MOJO.apply( ansi ).a( message ).reset();
return this;
}
public AnsiMessageBuffer project( Object message )
{
- return project().a( message ).reset();
- }
- public AnsiMessageBuffer reset()
- {
- ansi.reset();
+ Style.PROJECT.apply( ansi ).a( message ).reset();
return this;
}
diff --git a/src/main/java/org/apache/maven/shared/utils/logging/MessageBuffer.java b/src/main/java/org/apache/maven/shared/utils/logging/MessageBuffer.java
index c5c9d3d..26f717b 100644
--- a/src/main/java/org/apache/maven/shared/utils/logging/MessageBuffer.java
+++ b/src/main/java/org/apache/maven/shared/utils/logging/MessageBuffer.java
@@ -26,124 +26,89 @@
public interface MessageBuffer
{
/**
- * Insert color for DEBUG level display.
+ * Append message content for DEBUG level.
* By default, bold cyan
*/
- MessageBuffer debug();
+ MessageBuffer debug( Object message );
/**
- * Insert color for INFO level display.
+ * Append message content for INFO level.
* By default, bold blue
*/
- MessageBuffer info();
+ MessageBuffer info( Object message );
/**
- * Insert color for WARNING level or warning message display.
+ * Append message content in warning style or WARNING level.
* By default, bold yellow
*/
- MessageBuffer warning();
-
- /**
- * Append warning message: equivalent to appending warning color, then message, then reset.
- */
MessageBuffer warning( Object message );
/**
- * Insert color for ERROR level display.
+ * Append message content for ERROR level.
* By default, bold red
*/
- MessageBuffer error();
+ MessageBuffer error( Object message );
/**
- * Insert color for success message display.
+ * Append message content in success style.
* By default, bold green
*/
- MessageBuffer success();
-
- /**
- * Append success message: equivalent to appending success color, then message, then reset.
- */
MessageBuffer success( Object message );
/**
- * Insert color for failure message display.
+ * Append message content in failure style.
* By default, bold red
*/
- MessageBuffer failure();
-
- /**
- * Append failure message: equivalent to appending failure color, then message, then reset.
- */
MessageBuffer failure( Object message );
-
- /**
- * Insert color for strong message display.
- * By default, bold
- */
- MessageBuffer strong();
/**
- * Append strong message: equivalent to appending strong color, then message, then reset.
+ * Append message content in strong style.
+ * By default, bold
*/
MessageBuffer strong( Object message );
/**
- * Insert color for mojo message display.
+ * Append message content in mojo style.
* By default, green
*/
- MessageBuffer mojo();
-
- /**
- * Append mojo message: equivalent to appending mojo color, then message, then reset.
- */
MessageBuffer mojo( Object message );
/**
- * Insert color for project message display.
+ * Append message content in project style.
* By default, cyan
*/
- MessageBuffer project();
-
- /**
- * Append project message: equivalent to appending project color, then message, then reset.
- */
MessageBuffer project( Object message );
//
// message building methods modelled after Ansi methods
//
/**
- * Reset to default style.
- */
- MessageBuffer reset();
-
- /**
- * Append content to the buffer.
+ * Append content to the message buffer.
*/
MessageBuffer a( char[] value, int offset, int len );
/**
- * Append content to the buffer.
+ * Append content to the message buffer.
*/
MessageBuffer a( char[] value );
/**
- * Append content to the buffer.
+ * Append content to the message buffer.
*/
MessageBuffer a( CharSequence value, int start, int end );
/**
- * Append content to the buffer.
+ * Append content to the message buffer.
*/
MessageBuffer a( CharSequence value );
/**
- * Append content to the buffer.
+ * Append content to the message buffer.
*/
MessageBuffer a( Object value );
/**
- * Append a newline to the buffer.
+ * Append newline to the message buffer.
*/
MessageBuffer newline();
diff --git a/src/main/java/org/apache/maven/shared/utils/logging/PlainMessageBuffer.java b/src/main/java/org/apache/maven/shared/utils/logging/PlainMessageBuffer.java
index 7dadc41..b84776a 100644
--- a/src/main/java/org/apache/maven/shared/utils/logging/PlainMessageBuffer.java
+++ b/src/main/java/org/apache/maven/shared/utils/logging/PlainMessageBuffer.java
@@ -42,19 +42,14 @@
buffer = new StringBuilder( size );
}
- public PlainMessageBuffer debug()
+ public PlainMessageBuffer debug( Object message )
{
- return this;
+ return a( message );
}
- public PlainMessageBuffer info()
+ public PlainMessageBuffer info( Object message )
{
- return this;
- }
-
- public PlainMessageBuffer warning()
- {
- return this;
+ return a( message );
}
public PlainMessageBuffer warning( Object message )
@@ -62,14 +57,9 @@
return a( message );
}
- public PlainMessageBuffer error()
+ public PlainMessageBuffer error( Object message )
{
- return this;
- }
-
- public PlainMessageBuffer success()
- {
- return this;
+ return a( message );
}
public PlainMessageBuffer success( Object message )
@@ -77,51 +67,26 @@
return a( message );
}
- public PlainMessageBuffer failure()
- {
- return this;
- }
-
public PlainMessageBuffer failure( Object message )
{
return a( message );
}
- public PlainMessageBuffer strong()
- {
- return this;
- }
-
public PlainMessageBuffer strong( Object message )
{
return a( message );
}
- public PlainMessageBuffer mojo()
- {
- return this;
- }
-
public PlainMessageBuffer mojo( Object message )
{
return a( message );
}
- public PlainMessageBuffer project()
- {
- return this;
- }
-
public PlainMessageBuffer project( Object message )
{
return a( message );
}
- public PlainMessageBuffer reset()
- {
- return this;
- }
-
public PlainMessageBuffer a( char[] value, int offset, int len )
{
buffer.append( value, offset, len );
diff --git a/src/main/java/org/apache/maven/shared/utils/logging/Style.java b/src/main/java/org/apache/maven/shared/utils/logging/Style.java
index 41ecc7f..defc2aa 100644
--- a/src/main/java/org/apache/maven/shared/utils/logging/Style.java
+++ b/src/main/java/org/apache/maven/shared/utils/logging/Style.java
@@ -107,7 +107,7 @@
return null;
}
- void apply( Ansi ansi )
+ Ansi apply( Ansi ansi )
{
if ( bold )
{
@@ -135,6 +135,7 @@
ansi.bg( bgColor );
}
}
+ return ansi;
}
@Override
diff --git a/src/test/java/org/apache/maven/shared/utils/logging/AnsiMessageBufferTest.java b/src/test/java/org/apache/maven/shared/utils/logging/AnsiMessageBufferTest.java
index 4bcedec..55a436a 100644
--- a/src/test/java/org/apache/maven/shared/utils/logging/AnsiMessageBufferTest.java
+++ b/src/test/java/org/apache/maven/shared/utils/logging/AnsiMessageBufferTest.java
@@ -39,25 +39,17 @@
@Test
public void should_color_debug()
{
- ansiMessageBuffer.debug();
+ ansiMessageBuffer.debug( "a debug message" );
- assertThat( ansiMessageBuffer.toString(), equalTo( "\u001B[1;36m" ) );
+ assertThat( ansiMessageBuffer.toString(), equalTo( "\u001B[1;36ma debug message\u001B[m" ) );
}
@Test
public void should_color_info()
{
- ansiMessageBuffer.info();
+ ansiMessageBuffer.info( "an info message" );
- assertThat( ansiMessageBuffer.toString(), equalTo( "\u001B[1;34m" ) );
- }
-
- @Test
- public void should_color_warning()
- {
- ansiMessageBuffer.warning();
-
- assertThat( ansiMessageBuffer.toString(), equalTo( "\u001B[1;33m" ) );
+ assertThat( ansiMessageBuffer.toString(), equalTo( "\u001B[1;34man info message\u001B[m" ) );
}
@Test
@@ -71,17 +63,9 @@
@Test
public void should_color_error()
{
- ansiMessageBuffer.error();
+ ansiMessageBuffer.error( "an error message" );
- assertThat( ansiMessageBuffer.toString(), equalTo( "\u001B[1;31m" ) );
- }
-
- @Test
- public void should_color_success()
- {
- ansiMessageBuffer.success();
-
- assertThat( ansiMessageBuffer.toString(), equalTo( "\u001B[1;32m" ) );
+ assertThat( ansiMessageBuffer.toString(), equalTo( "\u001B[1;31man error message\u001B[m" ) );
}
@Test
@@ -93,14 +77,6 @@
}
@Test
- public void should_color_failure()
- {
- ansiMessageBuffer.failure();
-
- assertThat( ansiMessageBuffer.toString(), equalTo( "\u001B[1;31m" ) );
- }
-
- @Test
public void should_color_failure_and_reset()
{
ansiMessageBuffer.failure( "a failure message" );
@@ -109,14 +85,6 @@
}
@Test
- public void should_color_strong()
- {
- ansiMessageBuffer.strong();
-
- assertThat( ansiMessageBuffer.toString(), equalTo( "\u001B[1m" ) );
- }
-
- @Test
public void should_color_strong_and_reset()
{
ansiMessageBuffer.strong( "a strong message" );
@@ -125,14 +93,6 @@
}
@Test
- public void should_color_mojo()
- {
- ansiMessageBuffer.mojo();
-
- assertThat( ansiMessageBuffer.toString(), equalTo( "\u001B[32m" ) );
- }
-
- @Test
public void should_color_mojo_and_reset()
{
ansiMessageBuffer.mojo( "a mojo" );
@@ -141,14 +101,6 @@
}
@Test
- public void should_color_project()
- {
- ansiMessageBuffer.project();
-
- assertThat( ansiMessageBuffer.toString(), equalTo( "\u001B[36m" ) );
- }
-
- @Test
public void should_color_project_and_reset()
{
ansiMessageBuffer.project( "a project" );
