com.phloc.web.networkinterface.ComparatorNetworkInterfaceDisplayName Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * 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.phloc.web.networkinterface;

import java.net.NetworkInterface;
import java.text.Collator;
import java.util.Comparator;
import java.util.Locale;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.phloc.commons.compare.AbstractCollationComparator;
import com.phloc.commons.compare.ESortOrder;

/**
 * Comparator to compare {@link NetworkInterface} objects by their display name.
 * 
 * @author Philip Helger
 */
public class ComparatorNetworkInterfaceDisplayName extends AbstractCollationComparator 
{
  /**
   * Comparator with default locale {@link Collator} and default sort order.
   */
  public ComparatorNetworkInterfaceDisplayName ()
  {
    super ();
  }

  /**
   * Comparator with default locale {@link Collator} and default sort order and
   * a nested comparator.
   * 
   * @param aNestedComparator
   *        The nested comparator to be invoked, when the main comparison
   *        resulted in 0.
   */
  public ComparatorNetworkInterfaceDisplayName (@Nullable final Comparator  aNestedComparator)
  {
    super (aNestedComparator);
  }

  /**
   * Comparator with default locale {@link Collator}.
   * 
   * @param eSortOrder
   *        The sort order to use. May not be null.
   */
  public ComparatorNetworkInterfaceDisplayName (@Nonnull final ESortOrder eSortOrder)
  {
    super (eSortOrder);
  }

  /**
   * Comparator with default locale {@link Collator} and a nested comparator.
   * 
   * @param eSortOrder
   *        The sort order to use. May not be null.
   * @param aNestedComparator
   *        The nested comparator to be invoked, when the main comparison
   *        resulted in 0.
   */
  public ComparatorNetworkInterfaceDisplayName (@Nonnull final ESortOrder eSortOrder,
                                                @Nullable final Comparator  aNestedComparator)
  {
    super (eSortOrder, aNestedComparator);
  }

  /**
   * Comparator with default sort order and specified sort locale.
   * 
   * @param aSortLocale
   *        The locale to use. May be null.
   */
  public ComparatorNetworkInterfaceDisplayName (@Nullable final Locale aSortLocale)
  {
    super (aSortLocale);
  }

  /**
   * Comparator with default sort order but special locale and a nested
   * comparator.
   * 
   * @param aSortLocale
   *        The locale to use. May be null.
   * @param aNestedComparator
   *        The nested comparator to be invoked, when the main comparison
   *        resulted in 0.
   */
  public ComparatorNetworkInterfaceDisplayName (@Nullable final Locale aSortLocale,
                                                @Nullable final Comparator  aNestedComparator)
  {
    super (aSortLocale, aNestedComparator);
  }

  /**
   * Constructor with locale and sort order.
   * 
   * @param aSortLocale
   *        The locale to use. May be null.
   * @param eSortOrder
   *        The sort order to use. May not be null.
   */
  public ComparatorNetworkInterfaceDisplayName (@Nullable final Locale aSortLocale, @Nonnull final ESortOrder eSortOrder)
  {
    super (aSortLocale, eSortOrder);
  }

  /**
   * Constructor with locale and sort order and a nested comparator.
   * 
   * @param aSortLocale
   *        The locale to use. May be null.
   * @param eSortOrder
   *        The sort order to use. May not be null.
   * @param aNestedComparator
   *        The nested comparator to be invoked, when the main comparison
   *        resulted in 0.
   */
  public ComparatorNetworkInterfaceDisplayName (@Nullable final Locale aSortLocale,
                                                @Nonnull final ESortOrder eSortOrder,
                                                @Nullable final Comparator  aNestedComparator)
  {
    super (aSortLocale, eSortOrder, aNestedComparator);
  }

  /**
   * Constructor with {@link Collator} using the default sort order
   * 
   * @param aCollator
   *        The {@link Collator} to use. May not be null.
   */
  public ComparatorNetworkInterfaceDisplayName (@Nonnull final Collator aCollator)
  {
    super (aCollator);
  }

  /**
   * Constructor with {@link Collator} using the default sort order and a nested
   * comparator.
   * 
   * @param aCollator
   *        The {@link Collator} to use. May not be null.
   * @param aNestedComparator
   *        The nested comparator to be invoked, when the main comparison
   *        resulted in 0.
   */
  public ComparatorNetworkInterfaceDisplayName (@Nonnull final Collator aCollator,
                                                @Nullable final Comparator  aNestedComparator)
  {
    super (aCollator, aNestedComparator);
  }

  /**
   * Constructor with {@link Collator} and sort order.
   * 
   * @param aCollator
   *        The {@link Collator} to use. May not be null.
   * @param eSortOrder
   *        The sort order to use. May not be null.
   */
  public ComparatorNetworkInterfaceDisplayName (@Nonnull final Collator aCollator, @Nonnull final ESortOrder eSortOrder)
  {
    super (aCollator, eSortOrder);
  }

  /**
   * Constructor with {@link Collator} and sort order and a nested comparator.
   * 
   * @param aCollator
   *        The {@link Collator} to use. May not be null.
   * @param eSortOrder
   *        The sort order to use. May not be null.
   * @param aNestedComparator
   *        The nested comparator to be invoked, when the main comparison
   *        resulted in 0.
   */
  public ComparatorNetworkInterfaceDisplayName (@Nonnull final Collator aCollator,
                                                @Nonnull final ESortOrder eSortOrder,
                                                @Nullable final Comparator  aNestedComparator)
  {
    super (aCollator, eSortOrder, aNestedComparator);
  }

  @Override
  @Nullable
  protected String asString (@Nonnull final NetworkInterface aObject)
  {
    return aObject.getDisplayName ();
  }
}