001    /*
002     * Copyright 2002-2006 the original author or authors.
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License"); you may not
005     * use this file except in compliance with the License. You may obtain a copy of
006     * the License at
007     *
008     * http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
012     * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
013     * License for the specific language governing permissions and limitations under
014     * the License.
015     */
016    package org.springframework.richclient.application.splash;
017    
018    import org.springframework.richclient.progress.ProgressMonitor;
019    
020    /**
021     * A <code>MonitoringSplashScreen</code> can be used to provide feedback of the application startup phase
022     * 
023     * @author Mathias Broekelmann
024     * @since 0.3
025     */
026    public interface MonitoringSplashScreen extends SplashScreen {
027    
028        /**
029         * Returns this <code>SplashScreen</code>'s <code>ProgressMonitor</code>. Implementors wishing to show the
030         * progress to the user should return a <code>ProgressMonitor</code> that updates the user interface.
031         * 
032         * @return the <code>ProgressMonitor</code>, not null.
033         */
034        ProgressMonitor getProgressMonitor();
035    }