blob: 7a40e1b50bd90d260372b777564324e0f1963918 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Validator Group</title>
<style type="text/css">@import url("../../book.css");</style>
<style type="text/css">@import url("../../schema.css");</style>
</HEAD>
<BODY>
<H1 style="text-align:center">Validator Group</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.wst.validation.validatorGroup<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>WebTools 3.0
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>Defines a grouping for validators with listeners notified of group members' activites. Useful for pre-caching common information used by multiple validators and disposing of that information when they're all done.<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.group">group</a>+)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - A unique identifier for this extension</li>
<li><b>name</b> - A name for this extension</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.listener">listener</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST listener</p>
<p class="code SchemaDtdAttlist">class&nbsp;CDATA #REQUIRED&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
A listener for activities in this group.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>class</b> - The listener's class.</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.group">group</a> (<a href="#e.listener">listener</a>+)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST group</p>
<p class="code SchemaDtdAttlist">id&nbsp;IDREF #REQUIRED&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
Declares a validator group. A group may have multiple listeners.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - </li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>Define a listener that simply prints that it has been called.
<pre class="Example"><span class="code SchemaTag">
&lt;extension point=</span><span class="code SchemaCstring">&quot;org.eclipse.wst.validation.validatorGroup&quot;</span><span class="code SchemaTag">&gt;
&lt;group id=</span><span class="code SchemaCstring">&quot;validatorGroup&quot;</span><span class="code SchemaTag">&gt;
&lt;listener class=</span><span class="code SchemaCstring">&quot;org.eclipse.wst.validation.example.ValidatorGroupListener&quot;</span><span class="code SchemaTag">/&gt;
&lt;/group&gt;
&lt;/extension&gt;
public class org.eclipse.wst.validation.example.ValidatorGroupListener implements IValidatorGroupListener {
public ValidatorGroupListener() {
}
public void validationFinishing(IResource resource, IProgressMonitor monitor, ValType valType, ValOperation operation) {
System.out.println("Finishing:" + resource.getFullPath());
}
public void validationStarting(IResource resource, IProgressMonitor monitor, ValType valType, ValOperation operation) {
System.out.println("Starting:" + resource.getFullPath());
}
}
&lt;extension id=</span><span class="code SchemaCstring">&quot;id&quot;</span><span class="code SchemaTag"> name=</span><span class="code SchemaCstring">&quot;name&quot;</span><span class="code SchemaTag"> point=</span><span class="code SchemaCstring">&quot;org.eclipse.wst.validation.validatorV2&quot;</span><span class="code SchemaTag">&gt;
&lt;validator class=</span><span class="code SchemaCstring">&quot;org.eclipse.wst.validation.example.Validator&quot;</span><span class="code SchemaTag">&gt;
&lt;group id=</span><span class="code SchemaCstring">&quot;org.eclipse.wst.validation.example.validatorGroup&quot;</span><span class="code SchemaTag">/&gt;
&lt;/validator&gt;
&lt;/extension&gt;
</span></pre>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>Provisional API.
<p></p>
<br>
<p class="note SchemaCopyright">
Copyright (c) 2008 IBM Corporation and others.<br>
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 <a
href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>
</p>
</BODY>
</HTML>