io.github.agentsoz.bdiabm.data.PerceptContainer Maven / Gradle / Ivy

Go to download
package io.github.agentsoz.bdiabm.data;

/*
 * #%L
 * BDI-ABM Integration Package
 * %%
 * Copyright (C) 2014 - 2015 by its authors. See AUTHORS file.
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import java.io.Serializable;
import java.util.HashMap;
import java.util.Set;

import com.google.gson.Gson;

/**
 * This class stores all percepts of the agent
 */
public class PerceptContainer implements Serializable {
	private static final long serialVersionUID = -6502115824895738388L;

	/**
	 * {@link HashMap} where all the actions are stored. Key field is the
	 * percept's id, value field is the instance of{@link PerceptContent}, in
	 * which all information about the percept is stored.
	 */
	private HashMap container;

	/**
	 * @return Returns true if there are no percepts are stored in the container
	 */
	public boolean isEmpty() {
		return container.isEmpty();
	}

	/**
	 * Public constructor
	 */
	public PerceptContainer() {
		this(new HashMap());
	}

	/**
	 * Public constructor
	 * 
	 * @param container
	 *            is a {@link HashMap} where information about all percepts are
	 *            stored
	 */
	public PerceptContainer(HashMap container) {
		this.container = container;
	}

	/**
	 * @return IDs of all percepts
	 */
	public Set perceptIDSet() {
		return container.keySet();
	}

	/**
	 * Shallow copy of the container
	 * 
	 * @param x
	 *            The AbtractActionContainer which content want to be referred
	 *            to. (Shallow copy)
	 */
	public void copyContainer(PerceptContainer x) {
		container = x.container;
	}

	/**
	 * Empties the container
	 */
	public void clear() {
		container.clear();
	}

	/**
	 * Read the value of a percept, and remove it from the container.
	 * 
	 * @param identifier
	 *            percept's id
	 * @return value of percept, or null if it does not exists
	 */
	public Object read(String identifier) {
		return container.remove(identifier).getValue();
	}

	/**
	 * put the percept inside container, if previously a percept with the same
	 * ID exist it will replace the old value.
	 * 
	 * @param identifier
	 *            percept's id
	 * @param value
	 *            percept's value
	 * @param parameters
	 *            papameters associated with the percept
	 */
	public void put(String identifier, Object value) {
		container.put(identifier, new PerceptContent(identifier, value));
	}

	@Override
	public String toString() {
		return (isEmpty()) ? "{}" : new Gson().toJson(this);
	}
}