org.cp.elements.data.conversion.AbstractConversionService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cp-elements Show documentation

Java Simplified. Extensions and Useful Constructs for the Java Platform. Codeprimate Elements (a.k.a. cp-elements) is a Java library and micro-framework used to simplify the development of software applications written in Java. Elements packages several APIs into one library in order to address various application concerns and aspects of software design and development collectively and conveniently. Elements is a highly simple, yet robust and proven library built on solid OO principles, software design patterns and best practices to effectively solve common and reoccurring problems in software development.

There is a newer version: 2.0.0-M1

Show newest version

/*
 * Copyright 2016 Author or Authors.
 *
 * 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.cp.elements.data.conversion;

import static org.cp.elements.lang.ElementsExceptionsFactory.newConversionException;

/**
 * The {@link AbstractConversionService} class is an abstract base class encapsulating functionality
 * common to all service application components that perform value {@link Class type} conversions.
 *
 * @author John J. Blum
 * @see org.cp.elements.data.conversion.AbstractConverterRegistry
 * @see org.cp.elements.data.conversion.ConversionService
 * @see org.cp.elements.data.conversion.Converter
 * @since 1.0.0
 */
@SuppressWarnings("unused")
public abstract class AbstractConversionService extends AbstractConverterRegistry implements ConversionService {

  /**
   * Converts the given {@link Object} into a {@link Object value} of the {@link Class target type}.
   *
   * @param  {@link Class target type} of the conversion.
   * @param value {@link Object} to convert.
   * @param toType {@link Class target type} to convert the {@link Object} into.
   * @return the converted {@link Object} of the {@link Class target type} with the given {@code value}.
   * @throws ConversionException if the {@link Object} could not be converted into a {@link Object value}
   * of the desired {@link Class target type}.
   * @see org.cp.elements.data.conversion.Converter#convert(Object, Class)
   * @see org.cp.elements.data.conversion.Converter#convert(Object)
   */
  @SuppressWarnings("unchecked")
  public  T convert(Object value, Class toType) {

    for (ConverterDescriptor descriptor : getRegistry().keySet()) {

      Converter converter = descriptor.getConverter();

      if (converter.canConvert(value, toType)) {
        if (descriptor.isExactConversion(toType)) {
          return toType.cast(converter.convert(value));
        }
        else {
          return toType.cast(converter.convert(value, toType));
        }
      }
    }

    throw newConversionException("Cannot convert [%1$s] into Object of type [%2$s]",
      value, toType.getName());
  }
}