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.util.events;
020
021import java.util.Map;
022
023import org.jgrapes.core.Channel;
024import org.jgrapes.core.CompletionEvent;
025
026/**
027 * Defines an optional completion event for a {@link KeyValueStoreQuery}.
028 * 
029 * Because {@link KeyValueStoreQuery} events have a result, this event
030 * is not automatically generated for every {@link KeyValueStoreQuery}.
031 * Rather, it must be created explicitly.
032 */
033public class KeyValueStoreData extends CompletionEvent<KeyValueStoreQuery> {
034
035        /**
036         * @param monitoredEvent
037         * @param channels
038         */
039        public KeyValueStoreData(KeyValueStoreQuery monitoredEvent,
040                Channel... channels) {
041                super(monitoredEvent, channels);
042        }
043
044        /**
045         * A shortcut to get the result of the completed query event.
046         * 
047         * @return the data
048         */
049        public Map<String,String> data() {
050                try {
051                        return event().get();
052                } catch (InterruptedException e) {
053                        // Can only happen if invoked before completion
054                        throw new IllegalStateException(e);
055                }
056        }
057}