org.scijava.util.ConversionUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of scijava-common Show documentation
Show all versions of scijava-common Show documentation
SciJava Common is a shared library for SciJava software. It provides a plugin framework, with an extensible mechanism for service discovery, backed by its own annotation processor, so that plugins can be loaded dynamically. It is used by downstream projects in the SciJava ecosystem, such as ImageJ and SCIFIO.
/*
* #%L
* SciJava Common shared library for SciJava software.
* %%
* Copyright (C) 2009 - 2017 Board of Regents of the University of
* Wisconsin-Madison, Broad Institute of MIT and Harvard, Max Planck
* Institute of Molecular Cell Biology and Genetics, University of
* Konstanz, and KNIME GmbH.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
package org.scijava.util;
import java.lang.reflect.Type;
import org.scijava.convert.ConversionRequest;
import org.scijava.convert.ConvertService;
import org.scijava.convert.Converter;
import org.scijava.convert.DefaultConverter;
import org.scijava.util.Types;
/** @deprecated use {@link ConvertService} and {@link Types} */
@Deprecated
public class ConversionUtils {
private static ConvertService convertService;
private static Converter converterNoContext;
private static double servicePriority = 0.0;
private ConversionUtils() {
// prevent instantiation of utility class
}
// -- ConvertService setter --
/**
* Sets the {@link ConvertService} to use for handling conversion requests.
*/
public static void setDelegateService(final ConvertService convertService,
final double priority)
{
if (ConversionUtils.convertService == null || Double.compare(priority,
servicePriority) > 0)
{
ConversionUtils.convertService = convertService;
servicePriority = priority;
}
}
// -- Deprecated methods --
/**
* @deprecated
* @see Converter#convert(Object, Type)
*/
@Deprecated
public static Object convert(final Object src, final Type dest) {
final Converter handler = handler(new ConversionRequest(src, dest));
return (handler == null ? null : handler.convert(src, dest));
}
/**
* @deprecated
* @see Converter#convert(Object, Class)
*/
@Deprecated
public static T convert(final Object src, final Class dest) {
final Converter handler = handler(new ConversionRequest(src, dest));
return (handler == null ? null : handler.convert(src, dest));
}
/**
* @deprecated
* @see Converter#canConvert(Class, Type)
*/
@Deprecated
public static boolean canConvert(final Class src, final Type dest) {
final Converter handler = handler(new ConversionRequest(src, dest));
return (handler == null ? false : handler.canConvert(src, dest));
}
/**
* @deprecated
* @see Converter#canConvert(Class, Class)
*/
@Deprecated
public static boolean canConvert(final Class src, final Class dest) {
final Converter handler = handler(new ConversionRequest(src, dest));
return (handler == null ? false : handler.canConvert(src, dest));
}
/**
* @deprecated
* @see Converter#canConvert(Object, Type)
*/
@Deprecated
public static boolean canConvert(final Object src, final Type dest) {
final Converter handler = handler(new ConversionRequest(src, dest));
return (handler == null ? false : handler.canConvert(src, dest));
}
/**
* @deprecated
* @see Converter#canConvert(Object, Class)
*/
@Deprecated
public static boolean canConvert(final Object src, final Class dest) {
final Converter handler = handler(new ConversionRequest(src, dest));
return (handler == null ? false : handler.canConvert(src, dest));
}
/** @deprecated use {@link Types#enumValue} */
@Deprecated
public static T convertToEnum(final String src, final Class dest) {
try {
return Types.enumValue(src, dest);
}
catch (final IllegalArgumentException exc) {
return null;
}
}
/** @deprecated use {@link Types#raw} */
@Deprecated
public static Class getClass(final Type type) {
return Types.raw(type);
}
/** @deprecated use {@link Types#cast} */
@Deprecated
public static T cast(final Object src, final Class dest) {
if (!canCast(src, dest)) return null;
@SuppressWarnings("unchecked")
final T result = (T) src;
return result;
}
/** @deprecated use {@link Types#isAssignable} */
@Deprecated
public static boolean canAssign(final Class src, final Class dest) {
return canCast(src, dest);
}
/** @deprecated use {@link Types#isInstance} */
@Deprecated
public static boolean canAssign(final Object src, final Class dest) {
return canCast(src, dest);
}
/** @deprecated use {@link Types#isAssignable} */
@Deprecated
public static boolean canCast(final Class src, final Class dest) {
if (dest == null) return false;
if (src == null) return true;
return Types.isAssignable(Types.box(src), Types.box(dest));
}
/** @deprecated use {@link Types#isInstance} */
@Deprecated
public static boolean canCast(final Object src, final Class dest) {
if (dest == null) return false;
return src == null || canCast(src.getClass(), dest);
}
/** @deprecated use {@link Types#raws} and {@link Types#component} */
@Deprecated
public static Class getComponentClass(final Type type) {
return Types.raw(Types.component(type));
}
/** @deprecated use {@link Types#unbox} */
@Deprecated
public static Class getPrimitiveType(final Class type) {
return Types.unbox(type);
}
/** @deprecated use {@link Types#box} */
@Deprecated
public static Class getNonprimitiveType(final Class type) {
return Types.box(type);
}
/** @deprecated Use {@link Types#nullValue} instead. */
@Deprecated
public static T getNullValue(final Class type) {
return Types.nullValue(type);
}
// -- Helper methods --
/**
* Gets the {@link Converter} to use for the given conversion request. If the
* delegate {@link ConvertService} has not been explicitly set, then a
* {@link DefaultConverter} will be used.
*
* @return The {@link Converter} to use for handling the given request.
*/
private static Converter handler(final ConversionRequest data) {
if (convertService != null) return convertService.getHandler(data);
if (converterNoContext == null) converterNoContext = new DefaultConverter();
return converterNoContext;
}
}