io.wcm.qa.glnm.differences.util.DifferenceUtil Maven / Gradle / Ivy

Go to download
/*
 * #%L
 * wcm.io
 * %%
 * Copyright (C) 2018 wcm.io
 * %%
 * 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.
 * #L%
 */
package io.wcm.qa.glnm.differences.util;

import java.util.ArrayList;
import java.util.List;

import org.apache.commons.lang3.StringUtils;

import io.wcm.qa.glnm.differences.base.Difference;

/**
 * Helper methods for  {@link io.wcm.qa.glnm.differences.base.Differences} implementations.
 *
 * @since 1.0.0
 */
public final class DifferenceUtil {

  private DifferenceUtil() {
    // do not instantiate
  }

  /**
   * Joins the differences' names using the separator. Mostly useful for logging purposes.
   *
   * @param differences to get names from
   * @param separator to use between the elements.
   * @return all names joined using the separator.
   * @since 2.0.0
   */
  public static String joinNamesWith(Iterable differences, String separator) {
    List list = new ArrayList();
    for (Difference difference : differences) {
      list.add(difference.getName());
    }
    return StringUtils.join(list, separator);
  }

  /**
   * Joins the differences' tags using the separator. This makes implementation of the  {@link io.wcm.qa.glnm.differences.base.Differences} interface
   * easier.
   *
   * @param differences to get tag values from
   * @param separator to use between the elements.
   * @return all tag values joined using the separator.
   * @since 2.0.0
   */
  public static String joinTagsWith(Iterable differences, String separator) {
    List list = new ArrayList();
    for (Difference difference : differences) {
      list.add(difference.getTag());
    }
    return StringUtils.join(list, separator);
  }

}