1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 /*
19 * This is not the original file distributed by the Apache Software Foundation
20 * It has been modified by the Hipparchus project
21 */
22 package org.hipparchus.util;
23
24 import java.util.EventObject;
25
26 /**
27 * The root class from which all events occurring while running an
28 * {@link IterationManager} should be derived.
29 */
30 public class IterationEvent extends EventObject {
31 /** Serializable UID. */
32 private static final long serialVersionUID = 20120128L;
33
34 /** The number of iterations performed so far. */
35 private final int iterations;
36
37 /**
38 * Creates a new instance of this class.
39 *
40 * @param source the iterative algorithm on which the event initially
41 * occurred
42 * @param iterations the number of iterations performed at the time
43 * {@code this} event is created
44 */
45 public IterationEvent(final Object source, final int iterations) {
46 super(source);
47 this.iterations = iterations;
48 }
49
50 /**
51 * Returns the number of iterations performed at the time {@code this} event
52 * is created.
53 *
54 * @return the number of iterations performed
55 */
56 public int getIterations() {
57 return iterations;
58 }
59 }