| <!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.5.0) on Tue May 20 13:02:56 EDT 2008 --> |
| <TITLE> |
| IURIScheme |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.common.environment.uri.IURIScheme interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="IURIScheme"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= 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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IURIScheme.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIFilter.html" title="interface in org.eclipse.wst.common.environment.uri"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIVisitor.html" title="interface in org.eclipse.wst.common.environment.uri"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/eclipse/wst/common/environment/uri/IURIScheme.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IURIScheme.html" target="_top"><B>NO FRAMES</B></A> |
| <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <A NAME="main"></A> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.eclipse.wst.common.environment.uri</FONT> |
| <BR> |
| Interface IURIScheme</H2> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>IURIScheme</B></DL> |
| </PRE> |
| |
| <P> |
| A IURIScheme represents a single scheme for some a family of |
| Univeral Resource Identifiers. Examples include "file", "http" |
| and "platform" (Eclipse). |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.0</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> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIScheme.html#isHierarchical()">isHierarchical</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIScheme.html#isValid(org.eclipse.wst.common.environment.uri.IURI)">isValid</A></B>(<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A> uri)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIScheme.html#newURI(org.eclipse.wst.common.environment.uri.IURI)">newURI</A></B>(<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A> uri)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIScheme.html#newURI(java.lang.String)">newURI</A></B>(java.lang.String uri)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIScheme.html#newURI(java.net.URL)">newURI</A></B>(java.net.URL url)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIScheme.html#toString()">toString</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> org.eclipse.core.runtime.IStatus</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIScheme.html#validate(org.eclipse.wst.common.environment.uri.IURI)">validate</A></B>(<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A> uri)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <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="newURI(java.lang.String)"><!-- --></A><H3> |
| newURI</H3> |
| <PRE> |
| <A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A> <B>newURI</B>(java.lang.String uri) |
| throws <A HREF="../../../../../../org/eclipse/wst/common/environment/uri/URIException.html" title="class in org.eclipse.wst.common.environment.uri">URIException</A></PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>uri</CODE> - the URI to be created. |
| <DT><B>Returns:</B><DD>Returns a new IURI. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/URIException.html" title="class in org.eclipse.wst.common.environment.uri">URIException</A></CODE> - if the uri specified is not valid or |
| can not be created.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newURI(java.net.URL)"><!-- --></A><H3> |
| newURI</H3> |
| <PRE> |
| <A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A> <B>newURI</B>(java.net.URL url) |
| throws <A HREF="../../../../../../org/eclipse/wst/common/environment/uri/URIException.html" title="class in org.eclipse.wst.common.environment.uri">URIException</A></PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>url</CODE> - the url used to create the URI. |
| <DT><B>Returns:</B><DD>Returns a new IURI. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/URIException.html" title="class in org.eclipse.wst.common.environment.uri">URIException</A></CODE> - if the url specified is not valid or |
| can not be created.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newURI(org.eclipse.wst.common.environment.uri.IURI)"><!-- --></A><H3> |
| newURI</H3> |
| <PRE> |
| <A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A> <B>newURI</B>(<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A> uri) |
| throws <A HREF="../../../../../../org/eclipse/wst/common/environment/uri/URIException.html" title="class in org.eclipse.wst.common.environment.uri">URIException</A></PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>uri</CODE> - the URI to be created. |
| <DT><B>Returns:</B><DD>Returns a new IURI. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/URIException.html" title="class in org.eclipse.wst.common.environment.uri">URIException</A></CODE> - if the uri specified is not valid or |
| can not be created.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="toString()"><!-- --></A><H3> |
| toString</H3> |
| <PRE> |
| java.lang.String <B>toString</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Returns the proper name of the scheme.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isHierarchical()"><!-- --></A><H3> |
| isHierarchical</H3> |
| <PRE> |
| boolean <B>isHierarchical</B>()</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Returns true if and only if this is a hierarchical scheme.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isValid(org.eclipse.wst.common.environment.uri.IURI)"><!-- --></A><H3> |
| isValid</H3> |
| <PRE> |
| boolean <B>isValid</B>(<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A> uri)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>uri</CODE> - the uri to check for validity. |
| <DT><B>Returns:</B><DD>Returns true if and only if the given IURI satisfies the |
| grammatical requirements of the scheme. Absolute URIs must |
| begin with "<scheme>:". Relative URIs must either not contain |
| a colon, ":", or it must begin with "./".</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="validate(org.eclipse.wst.common.environment.uri.IURI)"><!-- --></A><H3> |
| validate</H3> |
| <PRE> |
| org.eclipse.core.runtime.IStatus <B>validate</B>(<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A> uri)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>uri</CODE> - the uri to check for validity. |
| <DT><B>Returns:</B><DD>Returns a Status object indicating whether or not the given |
| IURI is valid. The severity and message of the Status object |
| will describe this.</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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IURIScheme.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIFilter.html" title="interface in org.eclipse.wst.common.environment.uri"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIVisitor.html" title="interface in org.eclipse.wst.common.environment.uri"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/eclipse/wst/common/environment/uri/IURIScheme.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IURIScheme.html" target="_top"><B>NO FRAMES</B></A> |
| <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |