Skip to main content

This CGIT instance is deprecated, and repositories have been moved to Gitlab or Github. See the repository descriptions for specific locations.

summaryrefslogtreecommitdiffstats
blob: 23ef0b6ab7d87faaefdbd8f97f3f46551bd3c8dd (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
/*******************************************************************************
 * Copyright (c) 2006 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 * IBM Corporation - initial API and implementation
 * yyyymmdd bug      Email and other contact information
 * -------- -------- -----------------------------------------------------------
 * 20060419   132905 cbrealey@ca.ibm.com - Chris Brealey          
 *******************************************************************************/
package org.eclipse.jst.ws.internal.conformance;

import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.jdt.core.IType;

/**
 * @author cbrealey
 * This is an engine that walks a JDT model and runs rules.
 */
public interface IJavaWebServiceRuleEngine
{
	/**
	 * Analyzes the given class in the context of the given 
	 * project for compliance to a set of JAX-RPC rules.
	 * @param project The project context of the analysis.
	 * @param rootClass The IType of the class to analyze.
	 * @param rules The rules to use for the analysis.
	 * @return An IStatus summarizing the results of the analysis.
	 */
	public IStatus analyze ( IProject project, IType rootClass, JavaWebServiceRuleSet rules );
	
	/**
	 * Returns the JDTResolver in use by this analyzer.
	 * The JDTResolver is guaranteed not to be null only
	 * after the analyze method has been invoked and before
	 * the first rule is visited. This method is intended
	 * for use by implementations of IJavaWebServiceRule.
	 * @return The JDTResolver in use by this analyzer.
	 */
	public JDTResolver getJDTResolver ();
	
	/**
	 * Returns the progress monitor in use by this analyzer,
	 * or null if no progress monitor is in use.
	 * This method is intended for use by implementations
	 * of IJavaWebServiceRule.
	 * @return The progress monitor in use by this analyzer,
	 * or null for none.
	 */
	public IProgressMonitor getProgressMonitor ();
}

Back to the top