org.opentcs.util.persistence.v6.Comparators Maven / Gradle / Ivy

Go to download

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

openTCS-Common

There is a newer version: 6.2.0

/**
 * Copyright (c) The openTCS Authors.
 *
 * This program is free software and subject to the MIT license. (For details,
 * see the licensing information (LICENSE.txt) you should have received with
 * this copy of the software.)
 */
package org.opentcs.util.persistence.v6;

import java.util.Comparator;

/**
 * Some comparator implementations for JAXB classes.
 */
public final class Comparators {

  /**
   * Prevents instantiation.
   */
  private Comparators() {
  }

  /**
   * Returns a comparator for ordering PlantModelElementTOs ascendingly by their names.
   *
   * @return A comparator for ordering PlantModelElementTOs ascendingly by their names.
   */
  public static Comparator elementsByName() {
    return Comparator.comparing(PlantModelElementTO::getName);
  }

  /**
   * Returns a comparator for ordering OutgoingPaths ascendingly by their names.
   *
   * @return A comparator for ordering OutgoingPaths ascendingly by their names.
   */
  public static Comparator outgoingPathsByName() {
    return Comparator.comparing(PointTO.OutgoingPath::getName);
  }

  /**
   * Returns a comparator for ordering Links ascendingly by their point names.
   *
   * @return A comparator for ordering Links ascendingly by their point names.
   */
  public static Comparator linksByPointName() {
    return Comparator.comparing(LocationTO.Link::getPoint);
  }

  /**
   * Returns a comparator for ordering Propertiess ascendingly by their names.
   *
   * @return A comparator for ordering Properties ascendingly by their names.
   */
  public static Comparator propertiesByName() {
    return Comparator.comparing(PropertyTO::getName);
  }
}