org.osgi.service.blueprint.container.Converter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pax-swissbox-converter Show documentation

OPS4J Pax Swissbox - Utilities related to converting types.

There is a newer version: 1.8.5

Show newest version

/*
 * Copyright 2009 Alin Dreghiciu.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied.
 *
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.osgi.service.blueprint.container;

import javax.annotation.concurrent.ThreadSafe;

/**
 * Type converter to convert an object to a target type.
 *
 * @version $Revision: 7564 $
 */
@ThreadSafe
public interface Converter
{

    /**
     * Return if this converter is able to convert the specified object to the
     * specified type.
     *
     * @param sourceObject The source object s to convert.
     * @param targetType   The target type T.
     *
     * @return true if the conversion is possible,
     *         false otherwise.
     */
    boolean canConvert( Object sourceObject, ReifiedType targetType );

    /**
     * Convert the specified object to an instance of the specified type.
     *
     * @param sourceObject The source object s to convert.
     * @param targetType   The target type T.
     *
     * @return An instance with a type that is assignable from targetType's raw
     *         class
     *
     * @throws Exception If the conversion cannot succeed. This exception should
     *                   not be thrown when the {@link #canConvert canConvert} method has
     *                   returned true.
     */
    Object convert( Object sourceObject, ReifiedType targetType)
            throws Exception;
}