Replace buildToString(ValuesToString) by more general forEach(BiConsumer)

tpietzsch · tpietzsch · commit c7dcf2539e98 · 2020-06-10T23:29:20.000+02:00
This allows to define AbstractValues.toString() which will do by default
just printing of all modified (non-default) values, and allows subclasses
to override forEach() to include defaults which will be potentially useful
for other purposes as well.
Meaning, that ValuesToString is now just one possible BiConsumer.
diff --git a/src/main/java/org/scijava/optional/AbstractValues.java b/src/main/java/org/scijava/optional/AbstractValues.java
@@ -1,6 +1,7 @@
 package org.scijava.optional;
 
 import java.util.LinkedHashMap;
+import java.util.function.BiConsumer;
 
 public abstract class AbstractValues implements Values
 {
@@ -11,9 +12,17 @@ public AbstractValues( AbstractOptions< ? > options )
 		this.theOptions = options.theOptions;
 	}
 
-	public void buildToString( final ValuesToString sb )
+	public void forEach( BiConsumer< String, Object > action )
 	{
-		throw new UnsupportedOperationException( "internal, not supposed to be called" );
+		theOptions.forEach( action );
+	}
+
+	@Override
+	public String toString()
+	{
+		final ValuesToString sb = new ValuesToString();
+		forEach( sb );
+		return sb.toString();
 	}
 
 	@Override
@@ -24,7 +33,7 @@ public < T > T value( final String key, final T defaultValue )
 		return value == null ? defaultValue : value;
 	}
 
-	public class ValuesToString
+	public class ValuesToString implements BiConsumer< String, Object >
 	{
 		private final StringBuilder sb;
 
@@ -36,7 +45,15 @@ public ValuesToString()
 			first = true;
 		}
 
-		public < T > void append( final String key, final T value )
+		@Override
+		public String toString()
+		{
+			sb.append( "}" );
+			return sb.toString();
+		}
+
+		@Override
+		public void accept( final String key, final Object value )
 		{
 			if ( first )
 				first = false;
@@ -48,12 +65,5 @@ public < T > void append( final String key, final T value )
 			if ( !theOptions.containsKey( key ) )
 				sb.append( " [default]" );
 		}
-
-		@Override
-		public String toString()
-		{
-			sb.append( "}" );
-			return sb.toString();
-		}
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package org.scijava.optional;`
`2`	`2`
`3`	`3`	`import java.util.LinkedHashMap;`
	`4`	`+import java.util.function.BiConsumer;`
`4`	`5`
`5`	`6`	`public abstract class AbstractValues implements Values`
`6`	`7`	`{`
`@@ -11,9 +12,17 @@ public AbstractValues( AbstractOptions< ? > options )`
`11`	`12`	`this.theOptions = options.theOptions;`
`12`	`13`	`}`
`13`	`14`
`14`		`- public void buildToString( final ValuesToString sb )`
	`15`	`+ public void forEach( BiConsumer< String, Object > action )`
`15`	`16`	`{`
`16`		`- throw new UnsupportedOperationException( "internal, not supposed to be called" );`
	`17`	`+ theOptions.forEach( action );`
	`18`	`+ }`
	`19`	`+`
	`20`	`+ @Override`
	`21`	`+ public String toString()`
	`22`	`+ {`
	`23`	`+ final ValuesToString sb = new ValuesToString();`
	`24`	`+ forEach( sb );`
	`25`	`+ return sb.toString();`
`17`	`26`	`}`
`18`	`27`
`19`	`28`	`@Override`
`@@ -24,7 +33,7 @@ public < T > T value( final String key, final T defaultValue )`
`24`	`33`	`return value == null ? defaultValue : value;`
`25`	`34`	`}`
`26`	`35`
`27`		`- public class ValuesToString`
	`36`	`+ public class ValuesToString implements BiConsumer< String, Object >`
`28`	`37`	`{`
`29`	`38`	`private final StringBuilder sb;`
`30`	`39`
`@@ -36,7 +45,15 @@ public ValuesToString()`
`36`	`45`	`first = true;`
`37`	`46`	`}`
`38`	`47`
`39`		`- public < T > void append( final String key, final T value )`
	`48`	`+ @Override`
	`49`	`+ public String toString()`
	`50`	`+ {`
	`51`	`+ sb.append( "}" );`
	`52`	`+ return sb.toString();`
	`53`	`+ }`
	`54`	`+`
	`55`	`+ @Override`
	`56`	`+ public void accept( final String key, final Object value )`
`40`	`57`	`{`
`41`	`58`	`if ( first )`
`42`	`59`	`first = false;`
`@@ -48,12 +65,5 @@ public < T > void append( final String key, final T value )`
`48`	`65`	`if ( !theOptions.containsKey( key ) )`
`49`	`66`	`sb.append( " [default]" );`
`50`	`67`	`}`
`51`		`-`
`52`		`- @Override`
`53`		`- public String toString()`
`54`		`- {`
`55`		`- sb.append( "}" );`
`56`		`- return sb.toString();`
`57`		`- }`
`58`	`68`	`}`
`59`	`69`	`}`