001    /**
002     * Copyright 2004-2012 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
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,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.common.threads.listener;
017    
018    /**
019     * Keeps track of overall progress towards a goal.
020     *
021     * Notifies its listener whenever progress has occurred.
022     *
023     * Also notifies the listener when progress starts and completes.
024     */
025    public class ProgressNotifier<T> {
026    
027        ProgressListener<T> listener = new NoOpListener<T>();
028        int progress;
029        int total;
030    
031        public synchronized int getProgress() {
032            return progress;
033        }
034    
035        public synchronized void notify(ProgressEvent<T> event) {
036            if (progress == 0) {
037                listener.progressStarted();
038            }
039            progress++;
040            listener.progressOccurred(progress, total, event);
041            if (progress == total) {
042                listener.progressCompleted();
043            }
044        }
045    
046        public ProgressListener<T> getListener() {
047            return listener;
048        }
049    
050        public void setListener(ProgressListener<T> listener) {
051            this.listener = listener;
052        }
053    
054        public int getTotal() {
055            return total;
056        }
057    
058        public void setTotal(int total) {
059            this.total = total;
060        }
061    
062    }