com.helger.commons.equals.IEqualsImplementation 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-2022 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.equals;

import javax.annotation.Nonnull;

/**
 * Interface to implement for checking if two objects are identical. This
 * interface is only used within the {@link EqualsImplementationRegistry}.
 *
 * @author Philip Helger
 * @param 
 *        Type of objects to compare
 */
@FunctionalInterface
public interface IEqualsImplementation 
{
  /**
   * Check if the passed two objects are identical or not.
   *
   * @param aObj1
   *        First object. May not be null.
   * @param aObj2
   *        Second object. May not be null.
   * @return true if the passed objects are equals according to the
   *         specification of Object.class.
   */
  boolean areEqual (@Nonnull T aObj1, @Nonnull T aObj2);

  /**
   * @return true if this implementation is designed to work on an
   *         interface, but equals is called for an implementation of that
   *         interface and provides its own equal method.
   */
  default boolean implementationEqualsOverridesInterface ()
  {
    return true;
  }
}