/* Copyright (c) 2008-2023, Nathan Sweet
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
 * conditions are met:
 * 
 * - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the distribution.
 * - Neither the name of Esoteric Software nor the names of its contributors may be used to endorse or promote products derived
 * from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */

package com.esotericsoftware.kryo.util;

import com.esotericsoftware.kryo.Kryo;
import com.esotericsoftware.kryo.ReferenceResolver;

import java.util.ArrayList;

/** Uses an {@link IdentityObjectIntMap} to track objects that have already been written. This can handle a graph with any number
 * of objects, but is slightly slower than {@link ListReferenceResolver} for graphs with few objects. Compared to
 * {@link HashMapReferenceResolver}, this may provide better performance since the IdentityObjectIntMap does not normally allocate
 * for get or put.
 * @author Nathan Sweet */
public class MapReferenceResolver implements ReferenceResolver {
	private static final int DEFAULT_CAPACITY = 2048;

	protected Kryo kryo;
	protected final IdentityObjectIntMap<Object> writtenObjects = new IdentityObjectIntMap<>();
	protected final ArrayList<Object> readObjects = new ArrayList<>();
	private final int maximumCapacity;

	/** Creates a reference resolver with a default maximum capacity of 2048 */
	public MapReferenceResolver () {
		this(DEFAULT_CAPACITY);
	}

	/** Creates a reference resolver with the specified maximum capacity. The default value of 2048 is good enough in most cases.
	 * If the average object graph is larger than the default, increasing this value can provide better performance.
	 * @param maximumCapacity the capacity to trim written and read objects to when {@link #reset()} is called */
	public MapReferenceResolver (int maximumCapacity) {
		this.maximumCapacity = maximumCapacity;
	}

	public void setKryo (Kryo kryo) {
		this.kryo = kryo;
	}

	public int addWrittenObject (Object object) {
		int id = writtenObjects.size;
		writtenObjects.put(object, id);
		return id;
	}

	public int getWrittenId (Object object) {
		return writtenObjects.get(object, -1);
	}

	public int nextReadId (Class type) {
		int id = readObjects.size();
		readObjects.add(null);
		return id;
	}

	public void setReadObject (int id, Object object) {
		readObjects.set(id, object);
	}

	public Object getReadObject (Class type, int id) {
		return readObjects.get(id);
	}

	public void reset () {
		final int size = readObjects.size();
		readObjects.clear();
		if (size > maximumCapacity) {
			readObjects.trimToSize();
			readObjects.ensureCapacity(maximumCapacity);
		}
		writtenObjects.clear(maximumCapacity);
	}

	/** Returns false for all primitive wrappers and enums. */
	public boolean useReferences (Class type) {
		return !Util.isWrapperClass(type) && !Util.isEnum(type);
	}
}
