LocationUpdatedRemoteEvent.java

/*******************************************************************************
 * This file is part of OpenNMS(R).
 *
 * Copyright (C) 2010-2011 The OpenNMS Group, Inc.
 * OpenNMS(R) is Copyright (C) 1999-2011 The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * OpenNMS(R) 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 Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with OpenNMS(R).  If not, see:
 *      http://www.gnu.org/licenses/
 *
 * For more information contact:
 *     OpenNMS(R) Licensing <license@opennms.org>
 *     http://www.opennms.org/
 *     http://www.opennms.com/
 *******************************************************************************/

package org.opennms.features.poller.remote.gwt.client.remoteevents;

import org.opennms.features.poller.remote.gwt.client.location.LocationInfo;

/**
 * <p>LocationUpdatedRemoteEvent class.</p>
 *
 * @author ranger
 * @version $Id: $
 * @since 1.8.1
 */
public class LocationUpdatedRemoteEvent implements MapRemoteEvent {

	private static final long serialVersionUID = -9125047100641191970L;

	private LocationInfo m_locationInfo;

	/**
	 * <p>Constructor for LocationUpdatedRemoteEvent.</p>
	 */
	public LocationUpdatedRemoteEvent() {
	}

	/**
	 * <p>Constructor for LocationUpdatedRemoteEvent.</p>
	 *
	 * @param locationInfo a {@link org.opennms.features.poller.remote.gwt.client.location.LocationInfo} object.
	 */
	public LocationUpdatedRemoteEvent(final LocationInfo locationInfo) {
		m_locationInfo = locationInfo;
	}

	/**
	 * <p>getLocationInfo</p>
	 *
	 * @return a {@link org.opennms.features.poller.remote.gwt.client.location.LocationInfo} object.
	 */
	public LocationInfo getLocationInfo() {
		return m_locationInfo;
	}

	/** {@inheritDoc} */
	public void dispatch(final MapRemoteEventHandler locationManager) {
		locationManager.updateLocation(m_locationInfo);
	}

	/**
	 * <p>toString</p>
	 *
	 * @return a {@link java.lang.String} object.
	 */
	public String toString() {
		return "LocationUpdatedRemoteEvent[locationInfo=" + m_locationInfo + "]";
	}
}