All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.projectmonkey.internal.converter.IterableConverter Maven / Gradle / Ivy

/*
 * Copyright 2011 the original 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 net.projectmonkey.internal.converter;

import java.lang.reflect.Array;
import java.util.Collection;
import java.util.Iterator;

import net.projectmonkey.internal.util.ArrayIterator;
import net.projectmonkey.spi.ConditionalConverter;
import net.projectmonkey.spi.MappingContext;


/**
 * Support class for converting Iterable and psuedo-Iterable (array) instances. Implementors must
 * support source and destination types that are Iterable or array instances.
 * 
 * @author Jonathan Halterman
 */
abstract class IterableConverter implements ConditionalConverter {
  public D convert(MappingContext context) {
    S source = context.getSource();
    int sourceLength = getSourceLength(source);
    D destination = context.getDestination() == null ? createDestination(context, sourceLength)
        : context.getDestination();
    Class elementType = getElementType(context);

    int index = 0;
    for (Iterator iterator = getSourceIterator(source); iterator.hasNext(); index++) {
      Object sourceElement = iterator.next();
      MappingContext elementContext = context.create(sourceElement, elementType);
      Object element = context.getMappingEngine().map(elementContext);
      setElement(destination, element, index);
    }

    return destination;
  }

  /**
   * Creates a destination instance for the {@code destinationType} where the destination supports
   * element {@code length}.
   */
  protected abstract D createDestination(MappingContext context, int length);

  /**
   * Gets the contained element type for the {@code type} and nullable {@code genericType}.
   * 
   * @param type to retrieve element type for
   * @param genericType to retrieve element type for - maybe be null
   */
  protected Class getElementType(MappingContext context) {
    return Object.class;
  }

  /**
   * Gets an Iterator for the Iterable or psuedo-Iterable (array) {@code source}.
   */
  @SuppressWarnings("unchecked")
  protected Iterator getSourceIterator(S source) {
    return source.getClass().isArray() ? new ArrayIterator(source) : ((Iterable) source)
        .iterator();
  }

  /**
   * Gets the source length of the Iterable or psuedo-Iterable (array) {@code source}.
   */
  protected int getSourceLength(S source) {
    return source.getClass().isArray() ? Array.getLength(source) : ((Collection) source).size();
  }

  /**
   * Sets the {@code element} at the against the {@code destination} at the optional {@code index}.
   */
  protected abstract void setElement(D destination, Object element, int index);
}