com.helger.commons.hashcode.IHashCodeImplementation Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2014-2023 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.hashcode;

import javax.annotation.Nonnull;

/**
 * Interface to implement for custom hash code implementation. This interface is
 * only used within the {@link HashCodeImplementationRegistry}.
 *
 * @author Philip Helger
 * @param 
 *        The data type for which the hash code should be implemented
 */
@FunctionalInterface
public interface IHashCodeImplementation 
{
  /**
   * Get the hash code for the passed object
   *
   * @param aObj
   *        The object for which the hash code is to be calculated
   * @return The hash code for this object
   */
  int getHashCode (@Nonnull T aObj);
}