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 org.jgrapes.util.PreferencesStore;
022
023/**
024 * A special {@link ConfigurationUpdate} event that is used by
025 * the {@link PreferencesStore} for reporting the configuration
026 * on startup. Components that have no need to distinguish the 
027 * initial value propagation from real changes
028 * simply handle the {@link ConfigurationUpdate} events only. 
029 */
030public class InitialPreferences extends InitialConfiguration {
031
032    private final String applicationPath;
033
034    /**
035     * Create a new event. The path to the application's preferences
036     * (i.e. the base path without the trailing "`PreferencesStore`",
037     * see {@link PreferencesStore}) is passed as additional information.
038     */
039    public InitialPreferences(String applicationPath) {
040        this.applicationPath = applicationPath;
041    }
042
043    /**
044     * The absolute path of the application's preferences.
045     * 
046     * @return path 
047     */
048    public String applicationPath() {
049        return applicationPath;
050    }
051}