FIX : javadoc build script
[EMFCompare2.git] / doc / org.eclipse.emf.compare.doc / references / javadoc / org / eclipse / emf / compare / util / ETools.html
blob2da9ebbd0343a499dac4233d7f635bd4de5f94c0
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc (build 1.5.0_08) on Fri Apr 20 12:42:44 CEST 2007 -->
6 <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
7 <TITLE>
8 ETools (EMF Compare Javadoc)
9 </TITLE>
11 <META NAME="keywords" CONTENT="org.eclipse.emf.compare.util.ETools class">
13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
15 <SCRIPT type="text/javascript">
16 function windowTitle()
18 parent.document.title="ETools (EMF Compare Javadoc)";
20 </SCRIPT>
21 <NOSCRIPT>
22 </NOSCRIPT>
24 </HEAD>
26 <BODY BGCOLOR="white" onload="windowTitle();">
29 <!-- ========= START OF TOP NAVBAR ======= -->
30 <A NAME="navbar_top"><!-- --></A>
31 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
32 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
33 <TR>
34 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
35 <A NAME="navbar_top_firstrow"><!-- --></A>
36 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
37 <TR ALIGN="center" VALIGN="top">
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ETools.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
46 </TR>
47 </TABLE>
48 </TD>
49 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
50 </EM>
51 </TD>
52 </TR>
54 <TR>
55 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
56 &nbsp;<A HREF="../../../../../org/eclipse/emf/compare/util/EFactory.html" title="class in org.eclipse.emf.compare.util"><B>PREV CLASS</B></A>&nbsp;
57 &nbsp;<A HREF="../../../../../org/eclipse/emf/compare/util/FactoryException.html" title="class in org.eclipse.emf.compare.util"><B>NEXT CLASS</B></A></FONT></TD>
58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
59 <A HREF="../../../../../index.html?org/eclipse/emf/compare/util/ETools.html" target="_top"><B>FRAMES</B></A> &nbsp;
60 &nbsp;<A HREF="ETools.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
61 &nbsp;<SCRIPT type="text/javascript">
62 <!--
63 if(window==top) {
64 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
66 //-->
67 </SCRIPT>
68 <NOSCRIPT>
69 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
70 </NOSCRIPT>
73 </FONT></TD>
74 </TR>
75 <TR>
76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
80 </TR>
81 </TABLE>
82 <A NAME="skip-navbar_top"></A>
83 <!-- ========= END OF TOP NAVBAR ========= -->
85 <HR>
86 <!-- ======== START OF CLASS DATA ======== -->
87 <H2>
88 <FONT SIZE="-1">
89 org.eclipse.emf.compare.util</FONT>
90 <BR>
91 Class ETools</H2>
92 <PRE>
93 java.lang.Object
94 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.emf.compare.util.ETools</B>
95 </PRE>
96 <HR>
97 <DL>
98 <DT><PRE>public class <B>ETools</B><DT>extends java.lang.Object</DL>
99 </PRE>
102 This contains general support for ecore browsing.
106 <HR>
110 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
112 <A NAME="constructor_summary"><!-- --></A>
113 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
114 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
115 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
116 <B>Constructor Summary</B></FONT></TH>
117 </TR>
118 <TR BGCOLOR="white" CLASS="TableRowColor">
119 <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/compare/util/ETools.html#ETools()">ETools</A></B>()</CODE>
121 <BR>
122 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
123 </TR>
124 </TABLE>
125 &nbsp;
126 <!-- ========== METHOD SUMMARY =========== -->
128 <A NAME="method_summary"><!-- --></A>
129 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
130 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
131 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
132 <B>Method Summary</B></FONT></TH>
133 </TR>
134 <TR BGCOLOR="white" CLASS="TableRowColor">
135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
136 <CODE>static&nbsp;EClassifier[]</CODE></FONT></TD>
137 <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/compare/util/ETools.html#computeAllClassifiers(EPackage)">computeAllClassifiers</A></B>(EPackage&nbsp;ePackage)</CODE>
139 <BR>
140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Search all the classifiers recursively in a package.</TD>
141 </TR>
142 <TR BGCOLOR="white" CLASS="TableRowColor">
143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144 <CODE>static&nbsp;java.util.List</CODE></FONT></TD>
145 <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/compare/util/ETools.html#computeAllClassifiersList(EPackage)">computeAllClassifiersList</A></B>(EPackage&nbsp;ePackage)</CODE>
147 <BR>
148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Search all the classifiers recursively in a package.</TD>
149 </TR>
150 <TR BGCOLOR="white" CLASS="TableRowColor">
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152 <CODE>static&nbsp;java.util.List</CODE></FONT></TD>
153 <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/compare/util/ETools.html#computeAllClassifiersList(EPackage, boolean)">computeAllClassifiersList</A></B>(EPackage&nbsp;ePackage,
154 boolean&nbsp;classOnly)</CODE>
156 <BR>
157 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Search all the classifiers recursively in a package.</TD>
158 </TR>
159 <TR BGCOLOR="white" CLASS="TableRowColor">
160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161 <CODE>static&nbsp;EPackage</CODE></FONT></TD>
162 <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/compare/util/ETools.html#createPackageHierarchy(java.lang.String)">createPackageHierarchy</A></B>(java.lang.String&nbsp;path)</CODE>
164 <BR>
165 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a package and his children in an ecore model.</TD>
166 </TR>
167 <TR BGCOLOR="white" CLASS="TableRowColor">
168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169 <CODE>static&nbsp;EClassifier</CODE></FONT></TD>
170 <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/compare/util/ETools.html#getEClassifier(EPackage, java.lang.String)">getEClassifier</A></B>(EPackage&nbsp;ePackage,
171 java.lang.String&nbsp;name)</CODE>
173 <BR>
174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Search a classifier recursively in a package.</TD>
175 </TR>
176 <TR BGCOLOR="white" CLASS="TableRowColor">
177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
178 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
179 <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/compare/util/ETools.html#getEClassifierFactoryName(EClassifier)">getEClassifierFactoryName</A></B>(EClassifier&nbsp;eClassifier)</CODE>
181 <BR>
182 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a factory name for a classifier.</TD>
183 </TR>
184 <TR BGCOLOR="white" CLASS="TableRowColor">
185 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
187 <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/compare/util/ETools.html#getEClassifierFactoryShortName(EClassifier)">getEClassifierFactoryShortName</A></B>(EClassifier&nbsp;eClassifier)</CODE>
189 <BR>
190 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a factory short name for a classifier.</TD>
191 </TR>
192 <TR BGCOLOR="white" CLASS="TableRowColor">
193 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
195 <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/compare/util/ETools.html#getEClassifierPath(EClassifier)">getEClassifierPath</A></B>(EClassifier&nbsp;eClassifier)</CODE>
197 <BR>
198 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the full path of the classifier.</TD>
199 </TR>
200 <TR BGCOLOR="white" CLASS="TableRowColor">
201 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
203 <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/compare/util/ETools.html#getEClassifierShortPath(EClassifier)">getEClassifierShortPath</A></B>(EClassifier&nbsp;eClassifier)</CODE>
205 <BR>
206 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the short path of the classifier.</TD>
207 </TR>
208 <TR BGCOLOR="white" CLASS="TableRowColor">
209 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
210 <CODE>static&nbsp;EPackage</CODE></FONT></TD>
211 <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/compare/util/ETools.html#getEPackage(EPackage, java.lang.String)">getEPackage</A></B>(EPackage&nbsp;parent,
212 java.lang.String&nbsp;path)</CODE>
214 <BR>
215 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a package in a parent package.</TD>
216 </TR>
217 <TR BGCOLOR="white" CLASS="TableRowColor">
218 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
219 <CODE>static&nbsp;EStructuralFeature</CODE></FONT></TD>
220 <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/compare/util/ETools.html#getEStructuralFeature(EClassifier, java.lang.String)">getEStructuralFeature</A></B>(EClassifier&nbsp;currentEClassifier,
221 java.lang.String&nbsp;name)</CODE>
223 <BR>
224 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the feature with this classifier and this name.</TD>
225 </TR>
226 <TR BGCOLOR="white" CLASS="TableRowColor">
227 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
228 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
229 <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/compare/util/ETools.html#getURI(EObject)">getURI</A></B>(EObject&nbsp;object)</CODE>
231 <BR>
232 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a URI for the eObject,
233 i.e., either
234 the eProxyURI,
235 the URI of the eResource with the fragment produced by the eResource,
236 or the URI consisting of just the fragment that would be produced by a default Resource
237 with the eObject as its only contents.</TD>
238 </TR>
239 <TR BGCOLOR="white" CLASS="TableRowColor">
240 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
241 <CODE>static&nbsp;boolean</CODE></FONT></TD>
242 <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/compare/util/ETools.html#ofClass(EClassifier, java.lang.String)">ofClass</A></B>(EClassifier&nbsp;classifier,
243 java.lang.String&nbsp;type)</CODE>
245 <BR>
246 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates if the type corresponds to the name of the classifier.</TD>
247 </TR>
248 <TR BGCOLOR="white" CLASS="TableRowColor">
249 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
250 <CODE>static&nbsp;boolean</CODE></FONT></TD>
251 <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/compare/util/ETools.html#ofType(EClassifier, java.lang.String)">ofType</A></B>(EClassifier&nbsp;classifier,
252 java.lang.String&nbsp;type)</CODE>
254 <BR>
255 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates if an instance of the classifier is an instance of the type.</TD>
256 </TR>
257 <TR BGCOLOR="white" CLASS="TableRowColor">
258 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
259 <CODE>static&nbsp;EObject</CODE></FONT></TD>
260 <TD><CODE><B><A HREF="../../../../../org/eclipse/emf/compare/util/ETools.html#validate(EObject, boolean, java.lang.String)">validate</A></B>(EObject&nbsp;root,
261 boolean&nbsp;blocker,
262 java.lang.String&nbsp;message)</CODE>
264 <BR>
265 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;It validates the given EMF object.</TD>
266 </TR>
267 </TABLE>
268 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
269 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
270 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
271 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
272 </TR>
273 <TR BGCOLOR="white" CLASS="TableRowColor">
274 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
275 </TR>
276 </TABLE>
277 &nbsp;
280 <!-- ========= CONSTRUCTOR DETAIL ======== -->
282 <A NAME="constructor_detail"><!-- --></A>
283 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
284 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
285 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
286 <B>Constructor Detail</B></FONT></TH>
287 </TR>
288 </TABLE>
290 <A NAME="ETools()"><!-- --></A><H3>
291 ETools</H3>
292 <PRE>
293 public <B>ETools</B>()</PRE>
294 <DL>
295 </DL>
297 <!-- ============ METHOD DETAIL ========== -->
299 <A NAME="method_detail"><!-- --></A>
300 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
301 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
302 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
303 <B>Method Detail</B></FONT></TH>
304 </TR>
305 </TABLE>
307 <A NAME="getURI(EObject)"><!-- --></A><H3>
308 getURI</H3>
309 <PRE>
310 public static java.lang.String <B>getURI</B>(EObject&nbsp;object)</PRE>
311 <DL>
312 <DD>Returns a URI for the eObject,
313 i.e., either
314 the eProxyURI,
315 the URI of the eResource with the fragment produced by the eResource,
316 or the URI consisting of just the fragment that would be produced by a default Resource
317 with the eObject as its only contents.
319 <DD><DL>
320 <DT><B>Parameters:</B><DD><CODE>eObject</CODE> - the object for which to get the URI.
321 <DT><B>Returns:</B><DD>the URI for the object.</DL>
322 </DD>
323 </DL>
324 <HR>
326 <A NAME="validate(EObject, boolean, java.lang.String)"><!-- --></A><H3>
327 validate</H3>
328 <PRE>
329 public static EObject <B>validate</B>(EObject&nbsp;root,
330 boolean&nbsp;blocker,
331 java.lang.String&nbsp;message)</PRE>
332 <DL>
333 <DD>It validates the given EMF object. <p>
334 An error is put in the log if the validation failed. <p>
335 <li>!blocker || Diagnostic.OK => root</li>
336 <li>blocker && !Diagnostic.OK => null</li>
337 <li>root == null => null</li>
339 <DD><DL>
340 <DT><B>Parameters:</B><DD><CODE>root</CODE> - is the object to validate<DD><CODE>blocker</CODE> - indicates if the result must be Diagnostic.OK<DD><CODE>message</CODE> - is the error message to put in the log
341 <DT><B>Returns:</B><DD>the given object or null</DL>
342 </DD>
343 </DL>
344 <HR>
346 <A NAME="computeAllClassifiers(EPackage)"><!-- --></A><H3>
347 computeAllClassifiers</H3>
348 <PRE>
349 public static EClassifier[] <B>computeAllClassifiers</B>(EPackage&nbsp;ePackage)</PRE>
350 <DL>
351 <DD>Search all the classifiers recursively in a package.
353 <DD><DL>
354 <DT><B>Parameters:</B><DD><CODE>ePackage</CODE> - is the container
355 <DT><B>Returns:</B><DD>table of classifiers</DL>
356 </DD>
357 </DL>
358 <HR>
360 <A NAME="computeAllClassifiersList(EPackage)"><!-- --></A><H3>
361 computeAllClassifiersList</H3>
362 <PRE>
363 public static java.util.List <B>computeAllClassifiersList</B>(EPackage&nbsp;ePackage)</PRE>
364 <DL>
365 <DD>Search all the classifiers recursively in a package.
367 <DD><DL>
368 <DT><B>Parameters:</B><DD><CODE>ePackage</CODE> - is the container
369 <DT><B>Returns:</B><DD>list of classifiers</DL>
370 </DD>
371 </DL>
372 <HR>
374 <A NAME="computeAllClassifiersList(EPackage, boolean)"><!-- --></A><H3>
375 computeAllClassifiersList</H3>
376 <PRE>
377 public static java.util.List <B>computeAllClassifiersList</B>(EPackage&nbsp;ePackage,
378 boolean&nbsp;classOnly)</PRE>
379 <DL>
380 <DD>Search all the classifiers recursively in a package.
382 <DD><DL>
383 <DT><B>Parameters:</B><DD><CODE>ePackage</CODE> - is the container<DD><CODE>classOnly</CODE> - indicates that only the classes are kept
384 <DT><B>Returns:</B><DD>list of classifiers</DL>
385 </DD>
386 </DL>
387 <HR>
389 <A NAME="getEClassifier(EPackage, java.lang.String)"><!-- --></A><H3>
390 getEClassifier</H3>
391 <PRE>
392 public static EClassifier <B>getEClassifier</B>(EPackage&nbsp;ePackage,
393 java.lang.String&nbsp;name)</PRE>
394 <DL>
395 <DD>Search a classifier recursively in a package.
397 Remarks :
398 <li>It never returns classifier java.resources.Folder if name = "File"</li>
399 <li>It never returns classifier java.resources.Folder if name = "older"</li>
400 <li>It returns classifier java.resources.Folder for "Folder" or "resources.Folder"</li>
402 <DD><DL>
403 <DT><B>Parameters:</B><DD><CODE>ePackage</CODE> - is the container<DD><CODE>name</CODE> - is the classifier identifier
404 <DT><B>Returns:</B><DD>classifier or null if not found</DL>
405 </DD>
406 </DL>
407 <HR>
409 <A NAME="getEStructuralFeature(EClassifier, java.lang.String)"><!-- --></A><H3>
410 getEStructuralFeature</H3>
411 <PRE>
412 public static EStructuralFeature <B>getEStructuralFeature</B>(EClassifier&nbsp;currentEClassifier,
413 java.lang.String&nbsp;name)</PRE>
414 <DL>
415 <DD>Returns the feature with this classifier and this name.
417 <DD><DL>
418 <DT><B>Parameters:</B><DD><CODE>currentEClassifier</CODE> - is the classifier<DD><CODE>name</CODE> - is the feature name
419 <DT><B>Returns:</B><DD>the feature</DL>
420 </DD>
421 </DL>
422 <HR>
424 <A NAME="getEClassifierFactoryName(EClassifier)"><!-- --></A><H3>
425 getEClassifierFactoryName</H3>
426 <PRE>
427 public static java.lang.String <B>getEClassifierFactoryName</B>(EClassifier&nbsp;eClassifier)</PRE>
428 <DL>
429 <DD>Returns a factory name for a classifier. There is a factory by package.
430 The factory is used to create instances of classifiers.
431 <p> Sample : "ResourcesFactory" is the name of the factory
432 java.resources.ResourcesFactory
434 <DD><DL>
435 <DT><B>Parameters:</B><DD><CODE>eClassifier</CODE> - is the classifier
436 <DT><B>Returns:</B><DD>the factory name</DL>
437 </DD>
438 </DL>
439 <HR>
441 <A NAME="getEClassifierFactoryShortName(EClassifier)"><!-- --></A><H3>
442 getEClassifierFactoryShortName</H3>
443 <PRE>
444 public static java.lang.String <B>getEClassifierFactoryShortName</B>(EClassifier&nbsp;eClassifier)</PRE>
445 <DL>
446 <DD>Returns a factory short name for a classifier. There is a factory by package.
447 The factory is used to create instances of classifiers.
448 <p> Sample : "Resources" is the short name of the factory
449 java.resources.ResourcesFactory
451 <DD><DL>
452 <DT><B>Parameters:</B><DD><CODE>eClassifier</CODE> - is the classifier
453 <DT><B>Returns:</B><DD>the factory short name</DL>
454 </DD>
455 </DL>
456 <HR>
458 <A NAME="getEClassifierPath(EClassifier)"><!-- --></A><H3>
459 getEClassifierPath</H3>
460 <PRE>
461 public static java.lang.String <B>getEClassifierPath</B>(EClassifier&nbsp;eClassifier)</PRE>
462 <DL>
463 <DD>Returns the full path of the classifier.
464 <p> Sample : "java.resources.JavaFile"
465 is the full path for the classifier java.resources.JavaFile
467 <DD><DL>
468 <DT><B>Parameters:</B><DD><CODE>eClassifier</CODE> - is the classifier
469 <DT><B>Returns:</B><DD>full path of the classifier</DL>
470 </DD>
471 </DL>
472 <HR>
474 <A NAME="getEClassifierShortPath(EClassifier)"><!-- --></A><H3>
475 getEClassifierShortPath</H3>
476 <PRE>
477 public static java.lang.String <B>getEClassifierShortPath</B>(EClassifier&nbsp;eClassifier)</PRE>
478 <DL>
479 <DD>Returns the short path of the classifier.
480 <p> Sample : "resources.JavaFile" is the short path
481 for the classifier java.resources.JavaFile
483 <DD><DL>
484 <DT><B>Parameters:</B><DD><CODE>eClassifier</CODE> - is the classifier
485 <DT><B>Returns:</B><DD>short path of the classifier</DL>
486 </DD>
487 </DL>
488 <HR>
490 <A NAME="createPackageHierarchy(java.lang.String)"><!-- --></A><H3>
491 createPackageHierarchy</H3>
492 <PRE>
493 public static EPackage <B>createPackageHierarchy</B>(java.lang.String&nbsp;path)</PRE>
494 <DL>
495 <DD>Creates a package and his children in an ecore model.
496 The children are separated by '.'
497 <p> Sample : "a.b.c" is a package full path,<p>
498 "a", "b", and "c" packages are created, the root package "a" is returned.
500 <DD><DL>
501 <DT><B>Parameters:</B><DD><CODE>path</CODE> - is the package full path
502 <DT><B>Returns:</B><DD>the root package</DL>
503 </DD>
504 </DL>
505 <HR>
507 <A NAME="getEPackage(EPackage, java.lang.String)"><!-- --></A><H3>
508 getEPackage</H3>
509 <PRE>
510 public static EPackage <B>getEPackage</B>(EPackage&nbsp;parent,
511 java.lang.String&nbsp;path)</PRE>
512 <DL>
513 <DD>Get a package in a parent package.
514 <p> Sample : "a.b" is a parent package and "c.d" is a relative path,<p>
515 "a.b.c.d" package is returned.
517 <DD><DL>
518 <DT><B>Parameters:</B><DD><CODE>parent</CODE> - is the parent package<DD><CODE>path</CODE> - is the relative path of the required package
519 <DT><B>Returns:</B><DD>the required package, null if not found</DL>
520 </DD>
521 </DL>
522 <HR>
524 <A NAME="ofType(EClassifier, java.lang.String)"><!-- --></A><H3>
525 ofType</H3>
526 <PRE>
527 public static boolean <B>ofType</B>(EClassifier&nbsp;classifier,
528 java.lang.String&nbsp;type)</PRE>
529 <DL>
530 <DD>Indicates if an instance of the classifier is an instance of the type.
532 <DD><DL>
533 <DT><B>Parameters:</B><DD><CODE>classifier</CODE> - is the classifier<DD><CODE>type</CODE> - is the type
534 <DT><B>Returns:</B><DD>true if an instance of the classifier is an instance of the type</DL>
535 </DD>
536 </DL>
537 <HR>
539 <A NAME="ofClass(EClassifier, java.lang.String)"><!-- --></A><H3>
540 ofClass</H3>
541 <PRE>
542 public static boolean <B>ofClass</B>(EClassifier&nbsp;classifier,
543 java.lang.String&nbsp;type)</PRE>
544 <DL>
545 <DD>Indicates if the type corresponds to the name of the classifier.
547 <DD><DL>
548 <DT><B>Parameters:</B><DD><CODE>classifier</CODE> - is the classifier<DD><CODE>type</CODE> - is the type
549 <DT><B>Returns:</B><DD>true if the type corresponds to the name of the classifier</DL>
550 </DD>
551 </DL>
552 <!-- ========= END OF CLASS DATA ========= -->
553 <HR>
556 <!-- ======= START OF BOTTOM NAVBAR ====== -->
557 <A NAME="navbar_bottom"><!-- --></A>
558 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
559 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
560 <TR>
561 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
562 <A NAME="navbar_bottom_firstrow"><!-- --></A>
563 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
564 <TR ALIGN="center" VALIGN="top">
565 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
566 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
567 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
568 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ETools.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
569 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
570 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
571 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
572 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
573 </TR>
574 </TABLE>
575 </TD>
576 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
577 Copyright 2006 IBM Corporation and others.<br> All Rights Reserved.</EM>
578 </TD>
579 </TR>
581 <TR>
582 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
583 &nbsp;<A HREF="../../../../../org/eclipse/emf/compare/util/EFactory.html" title="class in org.eclipse.emf.compare.util"><B>PREV CLASS</B></A>&nbsp;
584 &nbsp;<A HREF="../../../../../org/eclipse/emf/compare/util/FactoryException.html" title="class in org.eclipse.emf.compare.util"><B>NEXT CLASS</B></A></FONT></TD>
585 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
586 <A HREF="../../../../../index.html?org/eclipse/emf/compare/util/ETools.html" target="_top"><B>FRAMES</B></A> &nbsp;
587 &nbsp;<A HREF="ETools.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
588 &nbsp;<SCRIPT type="text/javascript">
589 <!--
590 if(window==top) {
591 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
593 //-->
594 </SCRIPT>
595 <NOSCRIPT>
596 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
597 </NOSCRIPT>
600 </FONT></TD>
601 </TR>
602 <TR>
603 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
604 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
605 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
606 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
607 </TR>
608 </TABLE>
609 <A NAME="skip-navbar_bottom"></A>
610 <!-- ======== END OF BOTTOM NAVBAR ======= -->
612 <HR>
614 </BODY>
615 </HTML>