001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.commons.math3.util;
018    
019    import java.util.EventObject;
020    
021    /**
022     * The root class from which all events occurring while running an
023     * {@link IterationManager} should be derived.
024     *
025     * @version $Id: IterationEvent.java 1416643 2012-12-03 19:37:14Z tn $
026     */
027    public class IterationEvent extends EventObject {
028        /** */
029        private static final long serialVersionUID = 20120128L;
030    
031        /** The number of iterations performed so far. */
032        private final int iterations;
033    
034        /**
035         * Creates a new instance of this class.
036         *
037         * @param source the iterative algorithm on which the event initially
038         * occurred
039         * @param iterations the number of iterations performed at the time
040         * {@code this} event is created
041         */
042        public IterationEvent(final Object source, final int iterations) {
043            super(source);
044            this.iterations = iterations;
045        }
046    
047        /**
048         * Returns the number of iterations performed at the time {@code this} event
049         * is created.
050         *
051         * @return the number of iterations performed
052         */
053        public int getIterations() {
054            return iterations;
055        }
056     }