Skip to content

Commit 4345924

Browse files
committed
Refactor opString -> OpDescription
Extract the opString functionality out of OpInfo to a static utility method. There is not "one" way of generating Op descriptions as we will want to tailor things to particular audiences, so it makes sense to put the functionality in an external location.
1 parent 14b3494 commit 4345924

8 files changed

Lines changed: 74 additions & 69 deletions

File tree

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
package org.scijava.ops.api;
2+
3+
import org.scijava.struct.Member;
4+
5+
/**
6+
* Static utility class for formatting descriptions of Ops
7+
*/
8+
public final class OpDescription {
9+
10+
/**
11+
* Generates a basic {@link String} describing the given {@link OpInfo}
12+
*
13+
* @param info the {@link OpInfo} of interest
14+
* @return a descriptor for this {@link OpInfo}
15+
*/
16+
public static String basic(final OpInfo info) {
17+
return basic(info, null);
18+
}
19+
20+
/**
21+
* Writes a basic {@link String} describing the {@link OpInfo} of interest
22+
* <b>with a particular {@link Member} highlighted</b>.
23+
*
24+
* @param info the {@link OpInfo} of interest
25+
* @param special the {@link Member} to highlight
26+
* @return a descriptor for this {@link OpInfo}
27+
*/
28+
public static String basic(final OpInfo info, final Member<?> special) {
29+
final StringBuilder sb = new StringBuilder();
30+
sb.append(info.implementationName()).append("(\n\t Inputs:\n");
31+
for (final Member<?> arg : info.inputs()) {
32+
appendParam(sb, arg, special);
33+
}
34+
sb.append("\t Outputs:\n");
35+
appendParam(sb, info.output(), special);
36+
sb.append(")\n");
37+
return sb.toString();
38+
}
39+
40+
/**
41+
* Appends a {@link Member} to the {@link StringBuilder} writing the Op
42+
* string.
43+
*
44+
* @param sb the {@link StringBuilder}
45+
* @param arg the {@link Member} being appended to {@code sb}
46+
* @param special the {@link Member} to highlight
47+
*/
48+
private static void appendParam(final StringBuilder sb, final Member<?> arg,
49+
final Member<?> special) {
50+
if (arg == special) sb.append("==> \t"); // highlight special item
51+
else sb.append("\t\t");
52+
sb.append(arg.getType().getTypeName());
53+
sb.append(" ");
54+
sb.append(arg.getKey());
55+
if (!arg.getDescription().isEmpty()) {
56+
sb.append(" -> ");
57+
sb.append(arg.getDescription());
58+
}
59+
sb.append("\n");
60+
}
61+
}

‎scijava/scijava-ops-api/src/main/java/org/scijava/ops/api/OpInfo.java‎

Lines changed: 0 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -113,56 +113,4 @@ default int compareTo(final OpInfo that) {
113113

114114
/** A unique identifier for an Op */
115115
String id();
116-
117-
/**
118-
* Writes a basic {@link String} describing this {@link OpInfo}
119-
*
120-
* @return a descriptor for this {@link OpInfo}
121-
*/
122-
default String opString() {
123-
return opString(null);
124-
}
125-
126-
/**
127-
* Writes a basic {@link String} describing this {@link OpInfo} <b>with a
128-
* particular {@link Member} highlighted</b>.
129-
*
130-
* @param special the {@link Member} to highlight
131-
* @return a descriptor for this {@link OpInfo}
132-
*/
133-
default String opString(final Member<?> special) {
134-
final StringBuilder sb = new StringBuilder();
135-
sb.append(implementationName()).append("(\n\t Inputs:\n");
136-
for (final Member<?> arg : inputs()) {
137-
appendParam(sb, arg, special);
138-
}
139-
sb.append("\t Outputs:\n");
140-
appendParam(sb, output(), special);
141-
sb.append(")\n");
142-
return sb.toString();
143-
}
144-
145-
/**
146-
* Appends a {@link Member} to the {@link StringBuilder} writing the Op
147-
* string.
148-
*
149-
* @param sb the {@link StringBuilder}
150-
* @param arg the {@link Member} being appended to {@code sb}
151-
* @param special the {@link Member} to highlight
152-
*/
153-
private void appendParam(final StringBuilder sb, final Member<?> arg,
154-
final Member<?> special)
155-
{
156-
if (arg == special) sb.append("==> \t"); // highlight special item
157-
else sb.append("\t\t");
158-
sb.append(arg.getType().getTypeName());
159-
sb.append(" ");
160-
sb.append(arg.getKey());
161-
if (!arg.getDescription().isEmpty()) {
162-
sb.append(" -> ");
163-
sb.append(arg.getDescription());
164-
}
165-
sb.append("\n");
166-
}
167-
168116
}

‎scijava/scijava-ops-api/src/main/java/org/scijava/ops/api/features/MatchingResult.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77

88
import org.scijava.ops.api.OpCandidate;
99
import org.scijava.ops.api.OpCandidate.StatusCode;
10+
import org.scijava.ops.api.OpDescription;
1011
import org.scijava.ops.api.OpRef;
1112

1213
/**
@@ -117,7 +118,7 @@ public static String matchInfo(final MatchingResult res) {
117118
int count = 0;
118119
for (final OpCandidate candidate : candidates) {
119120
sb.append(++count + ". ");
120-
sb.append("\t" + candidate.opInfo().opString(candidate.getStatusItem()) + "\n");
121+
sb.append("\t" + OpDescription.basic(candidate.opInfo(), candidate.getStatusItem()) + "\n");
121122
final String status = candidate.getStatus();
122123
if (status != null)
123124
sb.append("\t" + status + "\n");

‎scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/matcher/impl/OpClassInfo.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
import org.scijava.meta.Versions;
4343
import org.scijava.ops.api.Hints;
4444
import org.scijava.ops.api.OpDependencyMember;
45+
import org.scijava.ops.api.OpDescription;
4546
import org.scijava.ops.api.OpInfo;
4647
import org.scijava.ops.engine.OpUtils;
4748
import org.scijava.ops.engine.struct.ClassOpDependencyMemberParser;
@@ -197,9 +198,7 @@ public int hashCode() {
197198
}
198199

199200
@Override
200-
public String toString() {
201-
return opString();
202-
}
201+
public String toString() { return OpDescription.basic(this); }
203202

204203
@Override
205204
public String version() {

‎scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/matcher/impl/OpFieldInfo.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
import org.scijava.common3.validity.ValidityProblem;
3939
import org.scijava.meta.Versions;
4040
import org.scijava.ops.api.Hints;
41+
import org.scijava.ops.api.OpDescription;
4142
import org.scijava.ops.api.OpInfo;
4243
import org.scijava.ops.engine.OpUtils;
4344
import org.scijava.ops.engine.struct.FieldInstance;
@@ -237,8 +238,6 @@ public int hashCode() {
237238
}
238239

239240
@Override
240-
public String toString() {
241-
return opString();
242-
}
241+
public String toString() { return OpDescription.basic(this); }
243242

244243
}

‎scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/matcher/impl/OpMethodInfo.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
import org.scijava.meta.Versions;
4949
import org.scijava.ops.api.Hints;
5050
import org.scijava.ops.api.OpDependencyMember;
51+
import org.scijava.ops.api.OpDescription;
5152
import org.scijava.ops.api.OpInfo;
5253
import org.scijava.ops.engine.OpUtils;
5354
import org.scijava.ops.engine.struct.MethodOpDependencyMemberParser;
@@ -499,7 +500,7 @@ public int hashCode() {
499500

500501
@Override
501502
public String toString() {
502-
return opString();
503+
return OpDescription.basic(this);
503504
}
504505

505506
@Override

‎scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/simplify/SimplifiedOpInfo.java‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,7 @@
1010
import org.scijava.common3.validity.ValidityProblem;
1111
import org.scijava.common3.validity.ValidityException;
1212
import org.scijava.meta.Versions;
13-
import org.scijava.ops.api.Hints;
14-
import org.scijava.ops.api.InfoChain;
15-
import org.scijava.ops.api.OpEnvironment;
16-
import org.scijava.ops.api.OpInfo;
13+
import org.scijava.ops.api.*;
1714
import org.scijava.ops.api.features.BaseOpHints.Simplification;
1815
import org.scijava.ops.api.features.OpMatchingException;
1916
import org.scijava.ops.engine.conversionLoss.LossReporter;
@@ -233,9 +230,7 @@ public StructInstance<?> createOpInstance(List<?> dependencies)
233230
}
234231

235232
@Override
236-
public String toString() {
237-
return opString();
238-
}
233+
public String toString() { return OpDescription.basic(this); }
239234

240235
@Override
241236
public int compareTo(final OpInfo that) {

‎scijava/scijava-ops-engine/src/test/java/org/scijava/ops/engine/JavadocParameterTest.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
import org.junit.jupiter.api.Test;
1616
import org.scijava.function.Computers;
1717
import org.scijava.function.Inplaces;
18+
import org.scijava.ops.api.OpDescription;
1819
import org.scijava.ops.api.OpInfo;
1920
import org.scijava.ops.spi.Op;
2021
import org.scijava.ops.spi.OpClass;
@@ -413,7 +414,7 @@ public void testJavadocClass() {
413414
}
414415

415416
@Test
416-
public void opStringRegressionTest() {
417+
public void opDescriptionRegressionTest() {
417418
Iterator<OpInfo> infos = ops.infos("test.javadoc.methodPR").iterator();
418419

419420
OpInfo info = infos.next();
@@ -442,7 +443,7 @@ public void opStringRegressionTest() {
442443
"==> java.util.List<java.lang.String> bar -> the second input\n" +
443444
" Outputs:\n" +
444445
" java.util.List<java.lang.Long> output -> foo + bar\n" + ")\n";
445-
actual = info.opString(info.inputs().get(1));
446+
actual = OpDescription.basic(info, info.inputs().get(1));
446447
Assertions.assertEquals(expected, actual);
447448
}
448449

0 commit comments

Comments
 (0)