Skip to content

Commit ffc89fa

Browse files
authored
Merge pull request #81 from scijava/scijava/scijava-ops-engine/narrow-return-types
Narrow Collection returns to Set/List
2 parents 106b628 + 9c6bd50 commit ffc89fa

2 files changed

Lines changed: 73 additions & 42 deletions

File tree

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

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@
3030
package org.scijava.ops.api;
3131

3232
import java.lang.reflect.Type;
33-
import java.util.Collection;
33+
import java.util.List;
34+
import java.util.Set;
3435

3536
import org.scijava.types.Nil;
3637

@@ -59,13 +60,13 @@
5960
public interface OpEnvironment {
6061

6162
/** The available ops for this environment. */
62-
Iterable<OpInfo> infos();
63+
List<OpInfo> infos();
6364

64-
Iterable<OpInfo> infos(String name);
65+
List<OpInfo> infos(String name);
6566

66-
Iterable<OpInfo> infos(Hints hints);
67+
List<OpInfo> infos(Hints hints);
6768

68-
Iterable<OpInfo> infos(String name, Hints hints);
69+
List<OpInfo> infos(String name, Hints hints);
6970

7071
// TODO: Add interface method: OpInfo info(final String opName, final Nil<T> specialType, final Nil<?>[] inTypes, final Nil<?> outType);
7172

@@ -721,15 +722,15 @@ default OpBuilder.Arity16 arity16(final String opName, final Hints hints) {
721722
/**
722723
* Creates an {@link OpInfo} from an {@link Class}.
723724
*
724-
* @param opClass
725+
* @param opClass the {@link Class} to derive the Op from
725726
* @return an {@link OpInfo} which can make instances of {@code opClass}
726727
*/
727728
OpInfo opify(Class<?> opClass);
728729

729730
/**
730731
* Creates an {@link OpInfo} from an {@link Class} with the given priority.
731732
*
732-
* @param opClass
733+
* @param opClass the {@link Class} to derive the Op from
733734
* @param priority - the assigned priority of the Op.
734735
* @param names - the name(s) of the Op
735736
* @return an {@link OpInfo} which can make instances of {@code opClass}
@@ -746,9 +747,9 @@ default OpBuilder.Arity16 arity16(final String opName, final Hints hints) {
746747
/**
747748
* Creates some {@link OpInfo}s from {@code o}
748749
* @param o the {@link Object} to create {@link OpInfo}s from
749-
* @return a {@link Collection} of {@link OpInfo}s
750+
* @return a {@link Set} of {@link OpInfo}s
750751
*/
751-
Collection<OpInfo> infosFrom(Object o);
752+
Set<OpInfo> infosFrom(Object o);
752753

753754
/**
754755
* Creates some {@link OpInfo}s from {@code o}
@@ -769,10 +770,10 @@ default void registerInfosFrom(Object o) {
769770
* Note that this method does not inherently provide <b>any</b> guarantees
770771
* pertaining to thread-safety; this API is provided purely for convenience.
771772
* Any calls to {@link OpEnvironment#op(String, Nil, Nil[], Nil)} that require
772-
* a specific {@Hints} should <b>not</b> use this method, instead opting for
773+
* a specific {@link Hints} should <b>not</b> use this method, instead opting for
773774
* {@link OpEnvironment#op(String, Nil, Nil[], Nil, Hints)}.
774775
*
775-
* @param hints
776+
* @param hints the {@link Hints} to be set as default
776777
*/
777778
void setDefaultHints(Hints hints);
778779

@@ -797,16 +798,16 @@ default void registerInfosFrom(Object o) {
797798
* Returns the descriptions for all Ops contained within this
798799
* {@link OpEnvironment}
799800
*
800-
* @return a {@link Collection} of descriptions
801+
* @return a {@link Set} of descriptions
801802
*/
802-
Collection<String> descriptions();
803+
List<String> descriptions();
803804

804805
/**
805806
* Returns the descriptions for all Ops identifiable by a given name within
806807
* this {@link OpEnvironment}
807808
*
808-
* @return a {@link Collection} of descriptions
809+
* @return a {@link Set} of descriptions
809810
*/
810-
Collection<String> descriptions(String name);
811+
List<String> descriptions(String name);
811812

812813
}

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

Lines changed: 57 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,19 @@
3232
import java.lang.reflect.ParameterizedType;
3333
import java.lang.reflect.Type;
3434
import java.lang.reflect.TypeVariable;
35-
import java.util.*;
35+
import java.util.ArrayList;
36+
import java.util.Arrays;
37+
import java.util.Collection;
38+
import java.util.Collections;
39+
import java.util.EnumSet;
40+
import java.util.HashMap;
41+
import java.util.List;
42+
import java.util.Map;
43+
import java.util.Objects;
44+
import java.util.ServiceLoader;
45+
import java.util.Set;
3646
import java.util.function.BiConsumer;
47+
import java.util.function.Function;
3748
import java.util.stream.Collectors;
3849
import java.util.stream.StreamSupport;
3950

@@ -42,11 +53,28 @@
4253
import org.scijava.log2.Logger;
4354
import org.scijava.log2.StderrLoggerFactory;
4455
import org.scijava.meta.Versions;
45-
import org.scijava.ops.api.*;
46-
import org.scijava.ops.api.features.*;
56+
import org.scijava.ops.api.Hints;
57+
import org.scijava.ops.api.InfoChain;
58+
import org.scijava.ops.api.InfoChainGenerator;
59+
import org.scijava.ops.api.OpCandidate;
60+
import org.scijava.ops.api.OpDependencyMember;
61+
import org.scijava.ops.api.OpEnvironment;
62+
import org.scijava.ops.api.OpHistory;
63+
import org.scijava.ops.api.OpInfo;
64+
import org.scijava.ops.api.OpInfoGenerator;
65+
import org.scijava.ops.api.OpInstance;
66+
import org.scijava.ops.api.OpMetadata;
67+
import org.scijava.ops.api.OpRef;
68+
import org.scijava.ops.api.OpWrapper;
69+
import org.scijava.ops.api.RichOp;
4770
import org.scijava.ops.api.features.BaseOpHints.Adaptation;
4871
import org.scijava.ops.api.features.BaseOpHints.DependencyMatching;
4972
import org.scijava.ops.api.features.BaseOpHints.Simplification;
73+
import org.scijava.ops.api.features.DependencyMatchingException;
74+
import org.scijava.ops.api.features.MatchingConditions;
75+
import org.scijava.ops.api.features.MatchingRoutine;
76+
import org.scijava.ops.api.features.OpMatcher;
77+
import org.scijava.ops.api.features.OpMatchingException;
5078
import org.scijava.ops.engine.hint.DefaultHints;
5179
import org.scijava.ops.engine.impl.DependencyRichOpInfoChain;
5280
import org.scijava.ops.engine.impl.LambdaTypeBaker;
@@ -91,7 +119,7 @@ public class DefaultOpEnvironment implements OpEnvironment {
91119
* search size for any Op request to the number of known Ops with the name
92120
* given in the request.
93121
*/
94-
private Map<String, Set<OpInfo>> opDirectory;
122+
private Map<String, List<OpInfo>> opDirectory;
95123

96124
/**
97125
* Data structure storing all known Ops, discoverable using their id.
@@ -166,30 +194,32 @@ public static List<MatchingRoutine> getMatchingRoutines(
166194
}
167195

168196
@Override
169-
public Set<OpInfo> infos() {
197+
public List<OpInfo> infos() {
170198
if (opDirectory == null) initOpDirectory();
171-
return opDirectory.values().stream().flatMap(Collection::stream).collect(
172-
Collectors.toSet());
199+
// NB distinct() prevents aliased Ops from appearing multiple times.
200+
return opDirectory.values().stream() //
201+
.flatMap(Collection::stream).distinct().sorted()
202+
.collect(Collectors.toUnmodifiableList());
173203
}
174204

175205
@Override
176-
public Set<OpInfo> infos(String name) {
206+
public List<OpInfo> infos(String name) {
177207
if (opDirectory == null) initOpDirectory();
178208
if (name == null || name.isEmpty()) return infos();
179209
return opsOfName(name);
180210
}
181211

182212
@Override
183-
public Set<OpInfo> infos(Hints hints) {
213+
public List<OpInfo> infos(Hints hints) {
184214
return filterInfos(infos(), hints);
185215
}
186216

187217
@Override
188-
public Set<OpInfo> infos(String name, Hints hints) {
218+
public List<OpInfo> infos(String name, Hints hints) {
189219
return filterInfos(infos(name), hints);
190220
}
191221

192-
private Set<OpInfo> filterInfos(Set<OpInfo> infos, Hints hints) {
222+
private List<OpInfo> filterInfos(List<OpInfo> infos, Hints hints) {
193223
boolean adapting = hints.contains(Adaptation.IN_PROGRESS);
194224
boolean simplifying = hints.contains(Simplification.IN_PROGRESS);
195225
// if we aren't doing any
@@ -201,7 +231,7 @@ private Set<OpInfo> filterInfos(Set<OpInfo> infos, Hints hints) {
201231
// filter out unadaptable ops
202232
.filter(info -> !simplifying || !info.declaredHints().contains(
203233
Simplification.FORBIDDEN)) //
204-
.collect(Collectors.toSet());
234+
.collect(Collectors.toList());
205235
}
206236

207237
@Override
@@ -318,20 +348,20 @@ else if (o instanceof Iterable<?>) {
318348
}
319349

320350
@Override
321-
public Collection<OpInfo> infosFrom(Object o) {
351+
public Set<OpInfo> infosFrom(Object o) {
322352
return infoGenerators().parallelStream() //
323353
.filter(g -> g.canGenerateFrom(o)) //
324354
.flatMap(g -> g.generateInfosFrom(o).stream()) //
325355
.collect(Collectors.toSet());
326356
}
327357

328358
@Override
329-
public Collection<String> descriptions() {
359+
public List<String> descriptions() {
330360
return descriptions(infos());
331361
}
332362

333363
@Override
334-
public Collection<String> descriptions(String name) {
364+
public List<String> descriptions(String name) {
335365
return descriptions(infos(name));
336366
}
337367

@@ -344,14 +374,14 @@ public Collection<String> descriptions(String name) {
344374
* returning multiple instances of the same {@link OpInfo}. The duplicate
345375
* {@link OpInfo}s are created when Ops have multiple names.
346376
*
347-
* @param infos
348-
* @return a set of {@link String}s, one describing each {@link OpInfo} in
349-
* {@code infos}.
377+
* @param infos an {@link Iterable} of {@link OpInfo}s
378+
* @return a {@link Set} of {@link String}s, one describing each
379+
* {@link OpInfo} in {@code infos}.
350380
*/
351381
private List<String> descriptions(Iterable<OpInfo> infos) {
352382
return StreamSupport.stream(infos.spliterator(), true) //
353383
.map(OpInfo::toString) //
354-
.collect(Collectors.toList());
384+
.collect(Collectors.toUnmodifiableList());
355385
}
356386

357387
@SuppressWarnings("unchecked")
@@ -697,7 +727,7 @@ private synchronized void initOpDirectory() {
697727
* @param generators the {@link List} of {@link OpInfoGenerator}s
698728
* @return a {@link List} of {@link OpInfo}s
699729
*/
700-
private Collection<OpInfo> opsFromObject(Object o, List<OpInfoGenerator> generators) {
730+
private List<OpInfo> opsFromObject(Object o, List<OpInfoGenerator> generators) {
701731
return generators.stream() //
702732
.filter(g -> g.canGenerateFrom(o)) //
703733
.flatMap(g -> g.generateInfosFrom(o).stream()) //
@@ -736,16 +766,16 @@ private synchronized void initIdDirectory() {
736766
return;
737767
}
738768
for (String opName : opInfo.names()) {
739-
opDirectory.putIfAbsent(opName, new TreeSet<>());
740-
boolean success = opDirectory.get(opName).add(opInfo);
741-
if (!success) System.out.println("Did not add OpInfo " + opInfo);
769+
opDirectory.computeIfAbsent(opName, name -> new ArrayList<>()).add(opInfo);
742770
}
743771
};
744772

745-
private Set<OpInfo> opsOfName(final String name) {
746-
final Set<OpInfo> ops = opDirectory.getOrDefault(name, Collections
747-
.emptySet());
748-
return Collections.unmodifiableSet(ops);
773+
private List<OpInfo> opsOfName(final String name) {
774+
// NB distinct() prevents aliased Ops from appearing multiple times.
775+
return opDirectory.getOrDefault(name, Collections.emptyList()).stream() //
776+
.distinct() //
777+
.sorted() //
778+
.collect(Collectors.toUnmodifiableList());
749779
}
750780

751781
/**

0 commit comments

Comments
 (0)