001/*
002 * JGrapes Event Driven Framework
003 * Copyright (C) 2017-2018 Michael N. Lipp
004 * 
005 * This program is free software; you can redistribute it and/or modify it 
006 * under the terms of the GNU Affero General Public License as published by 
007 * the Free Software Foundation; either version 3 of the License, or 
008 * (at your option) any later version.
009 * 
010 * This program is distributed in the hope that it will be useful, but 
011 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
012 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License 
013 * for more details.
014 * 
015 * You should have received a copy of the GNU Affero General Public License along 
016 * with this program; if not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jgrapes.webconsole.base.events;
020
021import org.jgrapes.core.Associator;
022import org.jgrapes.core.Event;
023
024/**
025 * A notification within the server side that an item has been updated.
026 * The item specification is usually the key used by the {@link Associator}.
027 * 
028 * This event should be fired by the component that provides the item and 
029 * may be handled by components that use information provided by the item.
030 * 
031 * @see ResourceNotAvailable
032 */
033@SuppressWarnings("PMD.DataClass")
034public class ResourceUpdated extends Event<Void> {
035
036    private final Object itemSpecification;
037
038    /**
039     * Creates a new event.
040     *
041     * @param itemSpecification information about the item, 
042     * usually the item's class.
043     */
044    public ResourceUpdated(Object itemSpecification) {
045        this.itemSpecification = itemSpecification;
046    }
047
048    /**
049     * Return the information that specifies the item. 
050     *
051     * @return the item specification
052     */
053    public Object itemSpecification() {
054        return itemSpecification;
055    }
056}