Skip to content

Commit ee22401

Browse files
gselzerhinerm
authored andcommitted
Exchange help op for descriptions API
1 parent ad15354 commit ee22401

7 files changed

Lines changed: 77 additions & 146 deletions

File tree

‎imagej/imagej-ops2/src/main/java/module-info.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,6 @@
7676
opens net.imagej.ops2.geom to therapi.runtime.javadoc, org.scijava.ops.engine;
7777
opens net.imagej.ops2.geom.geom2d to org.scijava, therapi.runtime.javadoc, org.scijava.ops.engine;
7878
opens net.imagej.ops2.geom.geom3d to therapi.runtime.javadoc, org.scijava.ops.engine;
79-
opens net.imagej.ops2.help to therapi.runtime.javadoc, org.scijava.ops.engine;
8079
opens net.imagej.ops2.identity to therapi.runtime.javadoc, org.scijava.ops.engine;
8180
opens net.imagej.ops2.image.ascii to therapi.runtime.javadoc, org.scijava.ops.engine;
8281
opens net.imagej.ops2.image.cooccurrenceMatrix to therapi.runtime.javadoc, org.scijava.ops.engine;

‎imagej/imagej-ops2/src/main/java/net/imagej/ops2/help/AbstractHelp.java‎

Lines changed: 0 additions & 81 deletions
This file was deleted.

‎imagej/imagej-ops2/src/main/java/net/imagej/ops2/help/HelpForName.java‎

Lines changed: 0 additions & 63 deletions
This file was deleted.

‎imagej/imagej-ops2/src/test/java/net/imagej/ops2/OpRegressionTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public class OpRegressionTest extends AbstractOpTest {
3939

4040
@Test
4141
public void opDiscoveryRegressionIT() {
42-
long expected = 1315;
42+
long expected = 1314;
4343
long actual = StreamSupport.stream(ops.infos().spliterator(), false).count();
4444
assertEquals(expected, actual);
4545
}

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131

3232
import java.lang.reflect.Type;
3333
import java.util.Collection;
34+
import java.util.List;
3435

3536
import org.scijava.types.Nil;
3637

@@ -267,4 +268,20 @@ default void registerInfosFrom(Object o) {
267268
*/
268269
Hints createHints(String... startingHints);
269270

271+
/**
272+
* Returns the descriptions for all Ops contained within this
273+
* {@link OpEnvironment}
274+
*
275+
* @return a {@link Collection} of descriptions
276+
*/
277+
Collection<String> descriptions();
278+
279+
/**
280+
* Returns the descriptions for all Ops identifiable by a given name within
281+
* this {@link OpEnvironment}
282+
*
283+
* @return a {@link Collection} of descriptions
284+
*/
285+
Collection<String> descriptions(String name);
286+
270287
}

‎scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/DefaultOpEnvironment.java‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
import java.util.*;
3636
import java.util.function.BiConsumer;
3737
import java.util.stream.Collectors;
38+
import java.util.stream.StreamSupport;
3839

3940
import org.scijava.discovery.Discoverer;
4041
import org.scijava.discovery.ManualDiscoverer;
@@ -325,6 +326,35 @@ public Collection<OpInfo> infosFrom(Object o) {
325326
.collect(Collectors.toSet());
326327
}
327328

329+
@Override
330+
public Collection<String> descriptions() {
331+
return descriptions(infos());
332+
}
333+
334+
@Override
335+
public Collection<String> descriptions(String name) {
336+
return descriptions(infos(name));
337+
}
338+
339+
/**
340+
* Helper method to get the descriptions for each {@link OpInfo} in
341+
* {@code infos}
342+
* <p>
343+
* NB we return a {@link List} here to preserve multiple instances of the same
344+
* {@link OpInfo}. This is consistent with {@link DefaultOpEnvironment#infos}
345+
* returning multiple instances of the same {@link OpInfo}. The duplicate
346+
* {@link OpInfo}s are created when Ops have multiple names.
347+
*
348+
* @param infos
349+
* @return a set of {@link String}s, one describing each {@link OpInfo} in
350+
* {@code infos}.
351+
*/
352+
private List<String> descriptions(Iterable<OpInfo> infos) {
353+
return StreamSupport.stream(infos.spliterator(), true) //
354+
.map(OpInfo::toString) //
355+
.collect(Collectors.toList());
356+
}
357+
328358
@SuppressWarnings("unchecked")
329359
private <T> RichOp<T> findOp(final String opName, final Nil<T> specialType,
330360
final Nil<?>[] inTypes, final Nil<?> outType, Hints hints)

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11

22
package org.scijava.ops.engine;
33

4+
import java.util.Collection;
5+
import java.util.Iterator;
6+
import java.util.List;
7+
import java.util.stream.Collectors;
8+
import java.util.stream.StreamSupport;
9+
410
import org.junit.jupiter.api.Assertions;
511
import org.junit.jupiter.api.Test;
612
import org.scijava.priority.Priority;
@@ -47,6 +53,29 @@ public void testRegister() {
4753
Assertions.assertEquals(expected, actual);
4854
}
4955

56+
@Test
57+
public void testDescriptions() {
58+
String opName = "test.opifyOp";
59+
OpInfo opifyOpInfo = ops.opify(OpifyOp.class, Priority.HIGH, opName);
60+
ops.register(opifyOpInfo);
61+
62+
// Get all descriptions matching our opName
63+
Collection<String> descriptions = ops.descriptions(opName);
64+
// (There should only be one)
65+
Assertions.assertEquals(1, descriptions.size());
66+
67+
// Get the Op matching the description
68+
Iterator<OpInfo> infos = ops.infos(opName).iterator();
69+
Assertions.assertTrue(infos.hasNext());
70+
OpInfo info = infos.next();
71+
// (Again, there should only be one)
72+
Assertions.assertFalse(infos.hasNext());
73+
74+
// Assert equality
75+
descriptions.forEach(d -> Assertions.assertEquals(info.toString(), d));
76+
77+
}
78+
5079
}
5180

5281
/**

0 commit comments

Comments
 (0)