org.pojomatic.diff.Difference Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pojomatic Show documentation

Automatically provides configurable implementations of the equals(Object), hashCode() and toString() methods inherited from java.lang.Object

There is a newer version: 2.2.1

Show newest version

package org.pojomatic.diff;

import java.util.NoSuchElementException;

/**
 * A difference between two objects, 'left' and 'right'.
 */
public interface Difference {

  /**
   * The name of the property.
   *
   * @return the name of the property
   */
  String propertyName();

  /**
   * The value from the left instance (possibly {@code null}).
   *
   * @return the value from the left instance (possibly {@code null})
   * @throws NoSuchElementException if the value does not exist on the left instance
   */
  Object leftValue() throws NoSuchElementException;

  /**
   * The value from the right instance (possibly {@code null}).
   *
   * @return the value from the right instance (possibly {@code null})
   * @throws NoSuchElementException if the value does not exist on the right instance
   */
  Object rightValue() throws NoSuchElementException;

}