View Javadoc

1   /*
2    * Copyright 2006 - 2012 Christina Bohk and Roland Ewald
3    *  
4    * Licensed under the Apache License, Version 2.0 (the "License"); 
5    * you may not use this file except in compliance with the License. 
6    * You may obtain a copy of the License at 
7    *  
8    *  http://www.apache.org/licenses/LICENSE-2.0
9    *  
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
13   * See the License for the specific language governing permissions and 
14   * limitations under the License. 
15   */
16  package p3j.misc.errors;
17  
18  import java.io.Serializable;
19  
20  /**
21   * Basic class for all kinds of errors that need to be signalled from the
22   * {@link p3j.simulation.assignments.plugintype.IParamAssignmentGenerator} to
23   * the user.
24   * 
25   * Created: August 17, 2008
26   * 
27   * @author Christina Bohk
28   * @author Roland Ewald
29   * 
30   */
31  public class GeneratorError implements Serializable {
32  
33  	/** Serialization ID. */
34  	private static final long serialVersionUID = 3738894619305980491L;
35  
36  	/** The error message. */
37  	private final String errorMessage;
38  
39  	/**
40  	 * Default constructor.
41  	 * 
42  	 * @param msg
43  	 *          the error message to be displayed
44  	 */
45  	public GeneratorError(String msg) {
46  		errorMessage = msg;
47  	}
48  
49  	public String getErrorMessage() {
50  		return errorMessage;
51  	}
52  
53  }