Skip to content

Commit fe72c9d

Browse files
committed
SciJavaService: clarify intent of the interface
1 parent 9472e67 commit fe72c9d

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

src/main/java/org/scijava/service/SciJavaService.java

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,23 @@
3535

3636
package org.scijava.service;
3737

38+
import org.scijava.Context;
39+
3840
/**
39-
* Marker interface for {@link Service}s used by SciJava-common
41+
* Marker interface for core SciJava Common {@link Service}s.
42+
* <p>
43+
* Note that this interface is not intended to be extended by non-core service
44+
* interfaces, because it serves as a marker for core SciJava Common services
45+
* <em>only</em>. The idea is that this interface can be used to create a
46+
* {@link Context} containing core SciJava services using the invocation:
47+
* </p>
48+
* <pre>
49+
* final Context context = new Context(SciJavaService.class);
50+
* </pre>
51+
* <p>
52+
* If you have a collection of services which you want to be grouped similarly,
53+
* just create your own marker interface for the same purpose.
54+
* </p>
4055
*
4156
* @author Mark Hiner
4257
*/

0 commit comments

Comments
 (0)