com.rapiddweller.common.operation.ComparableWrapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rd-lib-common Show documentation

'rapiddweller Common' is an open source Java library forked from Databene Commons by Volker Bergmann. It provides extensions to the Java core library by utility classes, abstract concepts and concrete implementations.

There is a newer version: 2.0.1-jdk-11

Show newest version

/*
 * Copyright (C) 2004-2015 Volker Bergmann ([email protected]).
 * All rights reserved.
 *
 * 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 com.rapiddweller.common.operation;

import com.rapiddweller.common.Converter;

/**
 * Wraps a data object with a helper object that can be compared independently of the data object.
 * Created: 26.02.2010 09:17:05
 *
 * @param  the type to wrap
 * @author Volker Bergmann
 * @since 0.5.0
 */
@SuppressWarnings({"unchecked", "rawtypes"})
public class ComparableWrapper implements Comparable {

  /**
   * The Comparable.
   */
  public final Comparable comparable;
  /**
   * The Real object.
   */
  public final E realObject;

  /**
   * Instantiates a new Comparable wrapper.
   *
   * @param comparable the comparable
   * @param realObject the real object
   */
  public ComparableWrapper(Comparable comparable, E realObject) {
    this.comparable = comparable;
    this.realObject = realObject;
  }

  @Override
  public int compareTo(ComparableWrapper that) {
    return this.comparable.compareTo(that.comparable);
  }

  /**
   * Wrap all comparable wrapper [ ].
   *
   * @param                the type parameter
   * @param realObjects       the real objects
   * @param comparableBuilder the comparable builder
   * @return the comparable wrapper [ ]
   */
  public static  ComparableWrapper[] wrapAll(T[] realObjects, Converter comparableBuilder) {
    ComparableWrapper[] result = new ComparableWrapper[realObjects.length];
    for (int i = 0; i < realObjects.length; i++) {
      T realObject = realObjects[i];
      Comparable comparable = (Comparable) comparableBuilder.convert(realObject);
      result[i] = new ComparableWrapper<>(comparable, realObject);
    }
    return result;
  }

}