org.hibernate.envers.internal.entities.mapper.PersistentCollectionChangeData Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hibernate-envers-jakarta Show documentation

Hibernate's entity version (audit/history) support Jakarta edition

The newest version!

/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or .
 */
package org.hibernate.envers.internal.entities.mapper;

import java.util.Map;

import org.hibernate.envers.tools.Pair;

/**
 * Data describing the change of a single object in a persistent collection (when the object was added, removed or
 * modified in the collection).
 *
 * @author Adam Warski (adam at warski dot org)
 */
public class PersistentCollectionChangeData {
	private final String entityName;
	private final Map data;
	private final Object changedElement;

	public PersistentCollectionChangeData(String entityName, Map data, Object changedElement) {
		this.entityName = entityName;
		this.data = data;
		this.changedElement = changedElement;
	}

	/**
	 * @return Name of the (middle) entity that holds the collection data.
	 */
	public String getEntityName() {
		return entityName;
	}

	public Map getData() {
		return data;
	}

	/**
	 * @return The affected element, which was changed (added, removed, modified) in the collection.
	 */
	public Object getChangedElement() {
		if ( changedElement instanceof Pair ) {
			return ( (Pair) changedElement ).getSecond();
		}

		if ( changedElement instanceof Map.Entry ) {
			return ( (Map.Entry) changedElement ).getValue();
		}

		return changedElement;
	}

	/**
	 * @return Index of the affected element, or {@code null} if the collection isn't indexed.
	 */
	public Object getChangedElementIndex() {
		if ( changedElement instanceof Pair ) {
			return ( (Pair) changedElement ).getFirst();
		}

		if ( changedElement instanceof Map.Entry ) {
			return ( (Map.Entry) changedElement ).getKey();
		}

		return null;
	}
}