Documentation update from php.net
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / compiler / IProblemFactory.java
1 /*******************************************************************************
2  * Copyright (c) 2000, 2003 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials 
4  * are made available under the terms of the Common Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/cpl-v10.html
7  * 
8  * Contributors:
9  *     IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package net.sourceforge.phpdt.internal.compiler;
12
13 import java.util.Locale;
14
15 import net.sourceforge.phpdt.core.compiler.IProblem;
16
17 /*
18  * Factory used from inside the compiler to build the actual problems which are
19  * handed back in the compilation result.
20  * 
21  * This allows sharing the internal problem representation with the environment.
22  * 
23  * Note: The factory is responsible for computing and storing a localized error
24  * message.
25  */
26
27 public interface IProblemFactory {
28
29         IProblem createProblem(char[] originatingFileName, int problemId,
30                         String[] problemArguments, String[] messageArguments, // shorter
31                                                                                                                                         // versions
32                                                                                                                                         // of the
33                                                                                                                                         // problemArguments
34                         int severity, int startPosition, int endPosition, int lineNumber);
35
36         Locale getLocale();
37
38         String getLocalizedMessage(int problemId, String[] messageArguments);
39 }