blob: 182c8c14d0beff3018cd4a7d42b8ed9f262b8f91 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_14) on Wed Apr 07 07:58:10 BST 2010 -->
<TITLE>
Jee5DomUtils
</TITLE>
<META NAME="date" CONTENT="2010-04-07">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Jee5DomUtils";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Jee5DomUtils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/util/DomSwitch.html" title="class in org.eclipse.jst.ws.jaxws.dom.runtime.util"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/util/ParamValueComparator.html" title="class in org.eclipse.jst.ws.jaxws.dom.runtime.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../../index.html?org/eclipse/jst/ws/jaxws/dom/runtime/util/Jee5DomUtils.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Jee5DomUtils.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.eclipse.jst.ws.jaxws.dom.runtime.util</FONT>
<BR>
Class Jee5DomUtils</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.jst.ws.jaxws.dom.runtime.util.Jee5DomUtils</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>Jee5DomUtils</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
Utility for some specification specific logics that are frequently used
while dealing with DOM objects.
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>Georgi Vachkov</DD>
</DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotation.html" title="interface in org.eclipse.jst.ws.jaxws.utils.annotations">IAnnotation</A>&lt;? extends org.eclipse.jdt.core.IJavaElement&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/util/Jee5DomUtils.html#findAnnotation(org.eclipse.emf.ecore.EObject, java.lang.String)">findAnnotation</A></B>(org.eclipse.emf.ecore.EObject&nbsp;eObject,
java.lang.String&nbsp;annFQName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Helper method to extract annotation with fully qualified name <code>annFQName</code></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/util/Jee5DomUtils.html" title="class in org.eclipse.jst.ws.jaxws.dom.runtime.util">Jee5DomUtils</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/util/Jee5DomUtils.html#getInstance()">getInstance</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/util/Jee5DomUtils.html#isNameRequired(org.eclipse.jst.ws.jaxws.dom.runtime.api.IWebParam)">isNameRequired</A></B>(<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IWebParam.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.api">IWebParam</A>&nbsp;webParam)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Method that decides if the param name is required to be put in the annotation according
to JSR-181 section 4.4.1 - attribute 'name' column 'meaning'.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/util/Jee5DomUtils.html#isNameUsed(org.eclipse.jst.ws.jaxws.dom.runtime.api.IWebParam)">isNameUsed</A></B>(<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IWebParam.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.api">IWebParam</A>&nbsp;webParam)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Method that decides is the attribute 'name' is used at all
according to JSR-181 section 4.4.1 - attribute 'name' column 'meaning'</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/util/Jee5DomUtils.html#isPartNameUsed(org.eclipse.jst.ws.jaxws.dom.runtime.api.IWebParam)">isPartNameUsed</A></B>(<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IWebParam.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.api">IWebParam</A>&nbsp;webParam)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Method that decides if the attribute 'partName' is used at all according
to JSR-181 section 4.4.1 - attribute 'partName' column 'meaning'.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="isPartNameUsed(org.eclipse.jst.ws.jaxws.dom.runtime.api.IWebParam)"><!-- --></A><H3>
isPartNameUsed</H3>
<PRE>
public boolean <B>isPartNameUsed</B>(<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IWebParam.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.api">IWebParam</A>&nbsp;webParam)</PRE>
<DL>
<DD>Method that decides if the attribute 'partName' is used at all according
to JSR-181 section 4.4.1 - attribute 'partName' column 'meaning'.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>webParam</CODE> - the webParam to be checked
<DT><B>Returns:</B><DD><code>true</code> in case partName is used</DL>
</DD>
</DL>
<HR>
<A NAME="isNameUsed(org.eclipse.jst.ws.jaxws.dom.runtime.api.IWebParam)"><!-- --></A><H3>
isNameUsed</H3>
<PRE>
public boolean <B>isNameUsed</B>(<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IWebParam.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.api">IWebParam</A>&nbsp;webParam)</PRE>
<DL>
<DD>Method that decides is the attribute 'name' is used at all
according to JSR-181 section 4.4.1 - attribute 'name' column 'meaning'
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>webParam</CODE> -
<DT><B>Returns:</B><DD>return <code>true</code> in case name is used</DL>
</DD>
</DL>
<HR>
<A NAME="findAnnotation(org.eclipse.emf.ecore.EObject, java.lang.String)"><!-- --></A><H3>
findAnnotation</H3>
<PRE>
public <A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotation.html" title="interface in org.eclipse.jst.ws.jaxws.utils.annotations">IAnnotation</A>&lt;? extends org.eclipse.jdt.core.IJavaElement&gt; <B>findAnnotation</B>(org.eclipse.emf.ecore.EObject&nbsp;eObject,
java.lang.String&nbsp;annFQName)</PRE>
<DL>
<DD>Helper method to extract annotation with fully qualified name <code>annFQName</code>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>eObject</CODE> - the object to search in<DD><CODE>annFQName</CODE> - the FQ name of searched annotation
<DT><B>Returns:</B><DD>found annotation or <code>null</code></DL>
</DD>
</DL>
<HR>
<A NAME="isNameRequired(org.eclipse.jst.ws.jaxws.dom.runtime.api.IWebParam)"><!-- --></A><H3>
isNameRequired</H3>
<PRE>
public boolean <B>isNameRequired</B>(<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IWebParam.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.api">IWebParam</A>&nbsp;webParam)</PRE>
<DL>
<DD>Method that decides if the param name is required to be put in the annotation according
to JSR-181 section 4.4.1 - attribute 'name' column 'meaning'.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>webParam</CODE> -
<DT><B>Returns:</B><DD><code>true</code> if the name attribute should be put on annotation</DL>
</DD>
</DL>
<HR>
<A NAME="getInstance()"><!-- --></A><H3>
getInstance</H3>
<PRE>
public static <A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/util/Jee5DomUtils.html" title="class in org.eclipse.jst.ws.jaxws.dom.runtime.util">Jee5DomUtils</A> <B>getInstance</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>the singleton instance</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Jee5DomUtils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/util/DomSwitch.html" title="class in org.eclipse.jst.ws.jaxws.dom.runtime.util"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/util/ParamValueComparator.html" title="class in org.eclipse.jst.ws.jaxws.dom.runtime.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../../index.html?org/eclipse/jst/ws/jaxws/dom/runtime/util/Jee5DomUtils.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Jee5DomUtils.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>