com.helger.commons.id.IHasID Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation

Java 1.8+ Library with tons of utility classes required in all projects

There is a newer version: 11.1.10

/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[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.helger.commons.id;

import java.util.Comparator;

import javax.annotation.Nonnull;

/**
 * Base interface for all objects having an ID.
 *
 * @author Philip Helger
 * @param 
 *        The type of the provided ID.
 */
@FunctionalInterface
public interface IHasID 
{
  /**
   * Get the unique ID of this object. If the type is {@link String} than the
   * returned value must match an XML NMToken expression (so e.g. no ':' in the
   * ID)!
   *
   * @return The ID of this object. May not be null.
   */
  IDTYPE getID ();

  @Nonnull
  static > Comparator > getComparatorID ()
  {
    return Comparator.comparing (IHasID::getID);
  }
}