CompleteData.java from Magellan-Client at Krugle

Show CompleteData.java syntax highlighted

/*
 *  Copyright (C) 2000-2004 Roger Butenuth, Andreas Gampe,
 *                          Stefan Goetz, Sebastian Pappert,
 *                          Klaas Prause, Enno Rehling,
 *                          Sebastian Tusk, Ulrich Kuester,
 *                          Ilja Pavkovic
 *
 * This file is part of the Eressea Java Code Base, see the
 * file LICENSING for the licensing information applying to
 * this file.
 *
 */

package com.eressea;

import java.util.Locale;
import java.util.Map;

import com.eressea.util.CollectionFactory;

/**
 * An implementation of the <tt>GameData</tt> supporting all of the attributes defined there. No
 * maps are defined as <tt>null</tt>.
 *
 * @see com.eressea.GameData
 */
public class CompleteData extends GameData {
	protected Map regions = CollectionFactory.createOrderedHashtable();
	protected Map units = CollectionFactory.createHashtable();
	protected Map tempUnits = CollectionFactory.createHashtable();
	protected Map factions = CollectionFactory.createOrderedHashtable();
	protected Map ships = CollectionFactory.createOrderedHashtable();
	protected Map buildings = CollectionFactory.createOrderedHashtable();
	protected Map islands = CollectionFactory.createOrderedHashtable();
	protected Map msgTypes = CollectionFactory.createOrderedHashtable();
	protected Map spells = CollectionFactory.createOrderedHashtable();
	protected Map potions = CollectionFactory.createOrderedHashtable();
	protected Map hotSpots = CollectionFactory.createOrderedHashtable();
	protected Map translations = CollectionFactory.createOrderedHashtable();
	protected Locale locale = null;
	protected Map selectedRegions = CollectionFactory.createTreeMap();

	/**
	 * TODO: DOCUMENT ME!
	 *
	 * @return TODO: DOCUMENT ME!
	 */
	public Map islands() {
		return islands;
	}

	/**
	 * TODO: DOCUMENT ME!
	 *
	 * @return TODO: DOCUMENT ME!
	 */
	public Map regions() {
		return regions;
	}

	/**
	 * TODO: DOCUMENT ME!
	 *
	 * @return TODO: DOCUMENT ME!
	 */
	public Map units() {
		return units;
	}

	/**
	 * TODO: DOCUMENT ME!
	 *
	 * @return TODO: DOCUMENT ME!
	 */
	public Map tempUnits() {
		return tempUnits;
	}

	/**
	 * TODO: DOCUMENT ME!
	 *
	 * @return TODO: DOCUMENT ME!
	 */
	public Map factions() {
		return factions;
	}

	/**
	 * TODO: DOCUMENT ME!
	 *
	 * @return TODO: DOCUMENT ME!
	 */
	public Map ships() {
		return ships;
	}

	/**
	 * TODO: DOCUMENT ME!
	 *
	 * @return TODO: DOCUMENT ME!
	 */
	public Map buildings() {
		return buildings;
	}

	/**
	 * TODO: DOCUMENT ME!
	 *
	 * @return TODO: DOCUMENT ME!
	 */
	public Map msgTypes() {
		return msgTypes;
	}

	/**
	 * TODO: DOCUMENT ME!
	 *
	 * @return TODO: DOCUMENT ME!
	 */
	public Map spells() {
		return spells;
	}

	/**
	 * TODO: DOCUMENT ME!
	 *
	 * @return TODO: DOCUMENT ME!
	 */
	public Map potions() {
		return potions;
	}


	/**
	 * Returns a collection of the coordinates of selected regions.
	 *
	 */
	public Map getSelectedRegionCoordinates() {
		return selectedRegions;
	}

	/**
	 * set a collection of selected regions.
	 *
	 * @param regions the map of coordinates of selected regions
	 */
	public void setSelectedRegionCoordinates(Map regions) {
		selectedRegions = CollectionFactory.createTreeMap();
		if(regions != null) {
			selectedRegions.putAll(regions);
		}
	}


	/**
	 * TODO: DOCUMENT ME!
	 *
	 * @return TODO: DOCUMENT ME!
	 */
	public Map hotSpots() {
		return hotSpots;
	}

	/**
	 * TODO: DOCUMENT ME!
	 *
	 * @return TODO: DOCUMENT ME!
	 */
	public Map translations() {
		return translations;
	}

	/**
	 * TODO: DOCUMENT ME!
	 *
	 * @param l TODO: DOCUMENT ME!
	 */
	public void setLocale(Locale l) {
		this.locale = l;
	}

	/**
	 * TODO: DOCUMENT ME!
	 *
	 * @return TODO: DOCUMENT ME!
	 */
	public Locale getLocale() {
		return locale;
	}

	/**
	 * Creates a new CompleteData object.
	 *
	 * @param rules TODO: DOCUMENT ME!
	 */
	public CompleteData(Rules rules) {
		super(rules);
	}

	/**
	 * Creates a new CompleteData object.
	 *
	 * @param rules TODO: DOCUMENT ME!
	 * @param name TODO: DOCUMENT ME!
	 */
	public CompleteData(Rules rules, String name) {
		super(rules, name);
	}
}
See more files for this project here