Skip to content

Commit 8215e54

Browse files
committed
Correct conversion service naming converntions
* package is now org.scijava.convert. Shouldn't have been a subpackage of *.util. * ConversionHandler is now just a Converter, to imply action. * ConversionService is now just ConvertService.
1 parent 5615610 commit 8215e54

File tree

13 files changed

+77
-77
lines changed

13 files changed

+77
-77
lines changed

src/main/java/org/scijava/util/conversion/AbstractConversionService.java renamed to src/main/java/org/scijava/convert/AbstractConvertService.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,22 +29,22 @@
2929
* #L%
3030
*/
3131

32-
package org.scijava.util.conversion;
32+
package org.scijava.convert;
3333

3434
import java.lang.reflect.Type;
3535

3636
import org.scijava.plugin.AbstractHandlerService;
3737
import org.scijava.util.ConversionUtils;
3838

3939
/**
40-
* Abstract superclass for {@link ConversionService} implementations. Sets
40+
* Abstract superclass for {@link ConvertService} implementations. Sets
4141
* this service as the active delegate service in {@link ConversionUtils}.
4242
*
4343
* @author Mark Hiner
4444
*/
45-
public abstract class AbstractConversionService extends
46-
AbstractHandlerService<ConversionRequest, ConversionHandler> implements
47-
ConversionService
45+
public abstract class AbstractConvertService extends
46+
AbstractHandlerService<ConversionRequest, Converter> implements
47+
ConvertService
4848
{
4949

5050
// -- ConversionService methods --
@@ -58,13 +58,13 @@ public Object convert(Object src, Type dest) {
5858
public <T> T convert(Object src, Class<T> dest) {
5959
// NB: repeated code with convert(ConversionRequest), because the
6060
// handler's convert method respects the T provided
61-
ConversionHandler handler = getHandler(src, dest);
61+
Converter handler = getHandler(src, dest);
6262
return handler == null ? null : handler.convert(src, dest);
6363
}
6464

6565
@Override
6666
public Object convert(ConversionRequest request) {
67-
ConversionHandler handler = getHandler(request);
67+
Converter handler = getHandler(request);
6868
return handler == null ? null : handler.convert(request);
6969
}
7070

src/main/java/org/scijava/util/conversion/AbstractConversionHandler.java renamed to src/main/java/org/scijava/convert/AbstractConverter.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@
2929
* #L%
3030
*/
3131

32-
package org.scijava.util.conversion;
32+
package org.scijava.convert;
3333

3434
import org.scijava.plugin.AbstractHandlerPlugin;
3535

3636
/**
37-
* Abstract superclass for {@link ConversionHandler} plugins. Performs
37+
* Abstract superclass for {@link Converter} plugins. Performs
3838
* appropriate dispatching of {@link #canConvert(ConversionRequest)} and
3939
* {@link #convert(ConversionRequest)} calls based on the actual state of the
4040
* given {@link ConversionRequest}.
@@ -45,8 +45,8 @@
4545
*
4646
* @author Mark Hiner
4747
*/
48-
public abstract class AbstractConversionHandler extends
49-
AbstractHandlerPlugin<ConversionRequest> implements ConversionHandler
48+
public abstract class AbstractConverter extends
49+
AbstractHandlerPlugin<ConversionRequest> implements Converter
5050
{
5151

5252
// -- ConversionHandler methods --

src/main/java/org/scijava/util/conversion/ConversionRequest.java renamed to src/main/java/org/scijava/convert/ConversionRequest.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,28 +29,28 @@
2929
* #L%
3030
*/
3131

32-
package org.scijava.util.conversion;
32+
package org.scijava.convert;
3333

3434
import java.lang.reflect.Type;
3535

3636
/**
37-
* Currency for use in {@link ConversionHandler} and {@link ConversionService}
37+
* Currency for use in {@link Converter} and {@link ConvertService}
3838
* methods.
3939
* <p>
4040
* {@link #ConversionRequest} provides a variety of constructors. Note that only
4141
* one destination type needs to be set (e.g. either a {@link Type} or a
4242
* {@link Class}).
4343
* </p>
4444
* <p>
45-
* Only the {@link Class} source needs to be set for {@link ConversionHandler}
45+
* Only the {@link Class} source needs to be set for {@link Converter}
4646
* lookup, such as through
47-
* {@link ConversionService#getHandler(ConversionRequest)}. However, to perform
47+
* {@link ConvertService#getHandler(ConversionRequest)}. However, to perform
4848
* an actual conversion, e.g. using
49-
* {@link ConversionHandler#convert(ConversionRequest)}, you must provide an
49+
* {@link Converter#convert(ConversionRequest)}, you must provide an
5050
* {@link Object} source.
5151
* </p>
5252
* <p>
53-
* NB: once a {@link ConversionHandler} has been acquired, the
53+
* NB: once a {@link Converter} has been acquired, the
5454
* {@code ConversionRequest} used for lookup can be reused to cast to the same
5555
* destination type, simply by updating the source object using the
5656
* {@link #setSourceObject(Object)} method.

src/main/java/org/scijava/util/conversion/ConversionService.java renamed to src/main/java/org/scijava/convert/ConvertService.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,58 +29,58 @@
2929
* #L%
3030
*/
3131

32-
package org.scijava.util.conversion;
32+
package org.scijava.convert;
3333

3434
import java.lang.reflect.Type;
3535

3636
import org.scijava.plugin.HandlerService;
3737

3838
/**
3939
* Service for converting between types using an extensible plugin:
40-
* {@link ConversionHandler}. Contains convenience signatures for the
40+
* {@link Converter}. Contains convenience signatures for the
4141
* {@link #getHandler} and {@link #supports} methods to avoid the need to create
4242
* {@link ConversionRequest} objects.
4343
*
4444
* @see ConversionRequest
4545
* @author Mark Hiner
4646
*/
47-
public interface ConversionService extends
48-
HandlerService<ConversionRequest, ConversionHandler>
47+
public interface ConvertService extends
48+
HandlerService<ConversionRequest, Converter>
4949
{
5050
/**
51-
* @see ConversionHandler#convert(Object, Type)
51+
* @see Converter#convert(Object, Type)
5252
*/
5353
Object convert(Object src, Type dest);
5454

5555
/**
56-
* @see ConversionHandler#convert(Object, Class)
56+
* @see Converter#convert(Object, Class)
5757
*/
5858
<T> T convert(Object src, Class<T> dest);
5959

6060
/**
61-
* @see ConversionHandler#convert(ConversionRequest)
61+
* @see Converter#convert(ConversionRequest)
6262
*/
6363
Object convert(ConversionRequest request);
6464

6565
/**
6666
* @see #getHandler(ConversionRequest)
6767
*/
68-
ConversionHandler getHandler(Object src, Class<?> dest);
68+
Converter getHandler(Object src, Class<?> dest);
6969

7070
/**
7171
* @see #getHandler(ConversionRequest)
7272
*/
73-
ConversionHandler getHandler(Class<?> src, Class<?> dest);
73+
Converter getHandler(Class<?> src, Class<?> dest);
7474

7575
/**
7676
* @see #getHandler(ConversionRequest)
7777
*/
78-
ConversionHandler getHandler(Object src, Type dest);
78+
Converter getHandler(Object src, Type dest);
7979

8080
/**
8181
* @see #getHandler(ConversionRequest)
8282
*/
83-
ConversionHandler getHandler(Class<?> src, Type dest);
83+
Converter getHandler(Class<?> src, Type dest);
8484

8585
/**
8686
* @see #supports(ConversionRequest)

src/main/java/org/scijava/util/conversion/ConversionHandler.java renamed to src/main/java/org/scijava/convert/Converter.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* #L%
3030
*/
3131

32-
package org.scijava.util.conversion;
32+
package org.scijava.convert;
3333

3434
import java.lang.reflect.Type;
3535
import java.util.Collection;
@@ -46,7 +46,7 @@
4646
* @see ConversionRequest
4747
* @author Mark Hiner
4848
*/
49-
public interface ConversionHandler extends HandlerPlugin<ConversionRequest> {
49+
public interface Converter extends HandlerPlugin<ConversionRequest> {
5050

5151
/**
5252
* Checks whether a given {@ConversionRequest} can be

src/main/java/org/scijava/util/conversion/DefaultConversionService.java renamed to src/main/java/org/scijava/convert/DefaultConvertService.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,25 +29,25 @@
2929
* #L%
3030
*/
3131

32-
package org.scijava.util.conversion;
32+
package org.scijava.convert;
3333

3434
import java.lang.reflect.Type;
3535

3636
import org.scijava.plugin.Plugin;
3737
import org.scijava.service.Service;
3838

3939
/**
40-
* Default {@link ConversionService} implementation.
40+
* Default {@link ConvertService} implementation.
4141
*
4242
* @author Mark Hiner
4343
*/
4444
@Plugin(type = Service.class)
45-
public class DefaultConversionService extends AbstractConversionService
45+
public class DefaultConvertService extends AbstractConvertService
4646
{
4747

4848
@Override
49-
public Class<ConversionHandler> getPluginType() {
50-
return ConversionHandler.class;
49+
public Class<Converter> getPluginType() {
50+
return Converter.class;
5151
}
5252

5353
@Override
@@ -58,22 +58,22 @@ public Class<ConversionRequest> getType() {
5858
// -- ConversionService methods --
5959

6060
@Override
61-
public ConversionHandler getHandler(final Object src, final Class<?> dest) {
61+
public Converter getHandler(final Object src, final Class<?> dest) {
6262
return getHandler(new ConversionRequest(src, dest));
6363
}
6464

6565
@Override
66-
public ConversionHandler getHandler(final Class<?> src, final Class<?> dest) {
66+
public Converter getHandler(final Class<?> src, final Class<?> dest) {
6767
return getHandler(new ConversionRequest(src, dest));
6868
}
6969

7070
@Override
71-
public ConversionHandler getHandler(final Object src, final Type dest) {
71+
public Converter getHandler(final Object src, final Type dest) {
7272
return getHandler(new ConversionRequest(src, dest));
7373
}
7474

7575
@Override
76-
public ConversionHandler getHandler(final Class<?> src, final Type dest) {
76+
public Converter getHandler(final Class<?> src, final Type dest) {
7777
return getHandler(new ConversionRequest(src, dest));
7878
}
7979

src/main/java/org/scijava/util/conversion/DefaultConversionHandler.java renamed to src/main/java/org/scijava/convert/DefaultConverter.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* #L%
3030
*/
3131

32-
package org.scijava.util.conversion;
32+
package org.scijava.convert;
3333

3434
import java.lang.reflect.Array;
3535
import java.lang.reflect.Constructor;
@@ -49,13 +49,13 @@
4949
import org.scijava.util.GenericUtils;
5050

5151
/**
52-
* Default {@link ConversionHandler} implementation. Provides useful conversion
52+
* Default {@link Converter} implementation. Provides useful conversion
5353
* functionality for many common conversion cases.
5454
*
5555
* @author Mark Hiner
5656
*/
57-
@Plugin(type = ConversionHandler.class)
58-
public class DefaultConversionHandler extends AbstractConversionHandler {
57+
@Plugin(type = Converter.class)
58+
public class DefaultConverter extends AbstractConverter {
5959

6060
// -- ConversionHandler methods --
6161

src/main/java/org/scijava/module/DefaultModuleService.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141

4242
import org.scijava.MenuPath;
4343
import org.scijava.Priority;
44+
import org.scijava.convert.ConvertService;
4445
import org.scijava.event.EventService;
4546
import org.scijava.input.Accelerator;
4647
import org.scijava.log.LogService;
@@ -59,7 +60,6 @@
5960
import org.scijava.service.Service;
6061
import org.scijava.thread.ThreadService;
6162
import org.scijava.util.ClassUtils;
62-
import org.scijava.util.conversion.ConversionService;
6363

6464
/**
6565
* Default service for keeping track of and executing available modules.
@@ -92,7 +92,7 @@ public class DefaultModuleService extends AbstractService implements
9292
private PrefService prefService;
9393

9494
@Parameter
95-
private ConversionService conversionService;
95+
private ConvertService conversionService;
9696

9797
/** Index of registered modules. */
9898
private ModuleIndex moduleIndex;

src/main/java/org/scijava/module/process/LoadInputsPreprocessor.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@
3131

3232
package org.scijava.module.process;
3333

34+
import org.scijava.convert.ConvertService;
3435
import org.scijava.module.Module;
3536
import org.scijava.module.ModuleItem;
3637
import org.scijava.module.ModuleService;
3738
import org.scijava.plugin.Parameter;
3839
import org.scijava.plugin.Plugin;
3940
import org.scijava.util.ConversionUtils;
40-
import org.scijava.util.conversion.ConversionService;
4141
import org.scijava.widget.InputHarvester;
4242

4343
/**
@@ -59,7 +59,7 @@ public class LoadInputsPreprocessor extends AbstractPreprocessorPlugin {
5959
private ModuleService moduleService;
6060

6161
@Parameter
62-
private ConversionService conversionService;
62+
private ConvertService conversionService;
6363

6464
// -- ModuleProcessor methods --
6565

src/main/java/org/scijava/script/ScriptInfo.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,14 @@
4949
import org.scijava.ItemVisibility;
5050
import org.scijava.NullContextException;
5151
import org.scijava.command.Command;
52+
import org.scijava.convert.ConvertService;
5253
import org.scijava.log.LogService;
5354
import org.scijava.module.AbstractModuleInfo;
5455
import org.scijava.module.DefaultMutableModuleItem;
5556
import org.scijava.module.ModuleException;
5657
import org.scijava.plugin.Parameter;
5758
import org.scijava.util.DigestUtils;
5859
import org.scijava.util.FileUtils;
59-
import org.scijava.util.conversion.ConversionService;
6060

6161
/**
6262
* Metadata about a script.
@@ -85,7 +85,7 @@ public class ScriptInfo extends AbstractModuleInfo implements Contextual {
8585
private ScriptService scriptService;
8686

8787
@Parameter
88-
private ConversionService conversionService;
88+
private ConvertService conversionService;
8989

9090
/**
9191
* Creates a script metadata object which describes the given script file.

0 commit comments

Comments
 (0)