blob: 47b12f87c1f7d96bcd8aee93713bc34196ece44b [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.5.0) on Tue May 20 13:02:56 EDT 2008 -->
<TITLE>
IURI
</TITLE>
<META NAME="keywords" CONTENT="org.eclipse.wst.common.environment.uri.IURI interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IURI";
}
</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>&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;<A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IURI.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;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIFactory.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/IURI.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IURI.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>
<A NAME="main"></A>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.eclipse.wst.common.environment.uri</FONT>
<BR>
Interface IURI</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IURI</B></DL>
</PRE>
<P>
A IURI represents a Univeral Resource Identifer.
<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>&nbsp;<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/IURI.html#append(org.eclipse.wst.common.environment.uri.IURI)">append</A></B>(<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A>&nbsp;relativeURI)</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;java.io.File</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html#asFile()">asFile</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;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html#asString()">asString</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;java.net.URL</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html#asURL()">asURL</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;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html#erase()">erase</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Erases the resource identified by this IURI.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.io.InputStream</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html#getInputStream()">getInputStream</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;java.io.OutputStream</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html#getOutputStream()">getOutputStream</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;<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIScheme.html" title="interface in org.eclipse.wst.common.environment.uri">IURIScheme</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html#getURIScheme()">getURIScheme</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/wst/common/environment/uri/IURI.html#isAvailableAsFile()">isAvailableAsFile</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/wst/common/environment/uri/IURI.html#isAvailableAsURL()">isAvailableAsURL</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/wst/common/environment/uri/IURI.html#isHierarchical()">isHierarchical</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/wst/common/environment/uri/IURI.html#isLeaf()">isLeaf</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/wst/common/environment/uri/IURI.html#isPresent()">isPresent</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/wst/common/environment/uri/IURI.html#isReadable()">isReadable</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/wst/common/environment/uri/IURI.html#isRelative()">isRelative</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/wst/common/environment/uri/IURI.html#isWritable()">isWritable</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;<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/IURI.html#list()">list</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of URIs for the immediate children of the given
hierarchical, non-leaf IURI.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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/IURI.html#list(org.eclipse.wst.common.environment.uri.IURIFilter)">list</A></B>(<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIFilter.html" title="interface in org.eclipse.wst.common.environment.uri">IURIFilter</A>&nbsp;uriFilter)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;As for list(), except only URIs that are accepted by the given
filter are returned in the array.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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/IURI.html#parent()">parent</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;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html#rename(org.eclipse.wst.common.environment.uri.IURI)">rename</A></B>(<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A>&nbsp;newURI)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Renames or moves the resource identified by this IURI
to the new IURI.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html#toString()">toString</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;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html#touchFolder()">touchFolder</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new folder resource at the location identified by
the IURI.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html#touchLeaf()">touchLeaf</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new, empty resource at the location identified by
the IURI.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html#visit(org.eclipse.wst.common.environment.uri.IURIVisitor)">visit</A></B>(<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIVisitor.html" title="interface in org.eclipse.wst.common.environment.uri">IURIVisitor</A>&nbsp;uriVisitor)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Visits this resource and its decendants in pre-order fashion.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html#visit(org.eclipse.wst.common.environment.uri.IURIVisitor, org.eclipse.wst.common.environment.uri.IURIFilter)">visit</A></B>(<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIVisitor.html" title="interface in org.eclipse.wst.common.environment.uri">IURIVisitor</A>&nbsp;uriVisitor,
<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIFilter.html" title="interface in org.eclipse.wst.common.environment.uri">IURIFilter</A>&nbsp;uriFilter)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;As for visit(IURIVisitor), except only resource URIs that are
accepted by the given filter are visited.</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="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 string form of the IURI.
The resource need not exist.</DL>
</DD>
</DL>
<HR>
<A NAME="getURIScheme()"><!-- --></A><H3>
getURIScheme</H3>
<PRE>
<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIScheme.html" title="interface in org.eclipse.wst.common.environment.uri">IURIScheme</A> <B>getURIScheme</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>Returns the IURIScheme for the scheme of this IURI.
The resource need not exist.</DL>
</DD>
</DL>
<HR>
<A NAME="isPresent()"><!-- --></A><H3>
isPresent</H3>
<PRE>
boolean <B>isPresent</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>Returns true iff the resource identified by this IURI exists.</DL>
</DD>
</DL>
<HR>
<A NAME="isLeaf()"><!-- --></A><H3>
isLeaf</H3>
<PRE>
boolean <B>isLeaf</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>Returns true iff the resource identified by this IURI exists
and is a leaf. Returns true always for non-hierarchical schemes.</DL>
</DD>
</DL>
<HR>
<A NAME="isReadable()"><!-- --></A><H3>
isReadable</H3>
<PRE>
boolean <B>isReadable</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>Returns true iff the resource identified by this IURI exists
and is readable. A readable leaf resource indicates that an
input stream can be opened on the resource. A readable folder
resource indicates that the children of the folder, if any,
can be determined via the list() or visit() methods.</DL>
</DD>
</DL>
<HR>
<A NAME="isWritable()"><!-- --></A><H3>
isWritable</H3>
<PRE>
boolean <B>isWritable</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>Returns true iff the resource identified by this IURI exists
and is writable. A writable leaf resource indicates that an
output stream can be opened on the resource. A writable folder
resource indicates that new resources can be created in the folder.</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 iff this IURI belongs to a hierarchical scheme.
The resource need not exist.
this.isHierarchical() == this.getURIScheme().isHierarchical().</DL>
</DD>
</DL>
<HR>
<A NAME="isRelative()"><!-- --></A><H3>
isRelative</H3>
<PRE>
boolean <B>isRelative</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>Returns true iff this IURI is a relative IURI.
The resource need not exist.</DL>
</DD>
</DL>
<HR>
<A NAME="parent()"><!-- --></A><H3>
parent</H3>
<PRE>
<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A> <B>parent</B>()
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>Returns:</B><DD>Returns the IURI of the folder containing this IURI.
The resource need not exist.
<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 there is no parent URI.</DL>
</DD>
</DL>
<HR>
<A NAME="append(org.eclipse.wst.common.environment.uri.IURI)"><!-- --></A><H3>
append</H3>
<PRE>
<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A> <B>append</B>(<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A>&nbsp;relativeURI)
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>relativeURI</CODE> - a relative URI.
<DT><B>Returns:</B><DD>Returns a new, normalized IURI formed by appending the given
relative IURI to this IURI. Both URIs must be hierarchical.
The resulting IURI will always be hierarchical. The given
IURI must be relative. This IURI can be relative or absolute.
the resulting IURI will be equivalently relative or absolute.
<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 relativeURI is not relative.</DL>
</DD>
</DL>
<HR>
<A NAME="getInputStream()"><!-- --></A><H3>
getInputStream</H3>
<PRE>
java.io.InputStream <B>getInputStream</B>()
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>Returns:</B><DD>Gets an InputStream for reading from the resource
identified by this leaf or non-hierarchical 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 a stream for this URI can not be created.</DL>
</DD>
</DL>
<HR>
<A NAME="getOutputStream()"><!-- --></A><H3>
getOutputStream</H3>
<PRE>
java.io.OutputStream <B>getOutputStream</B>()
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>Returns:</B><DD>Gets an OutputStream for writing to the resource
identified by this leaf or non-hierarchical 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 a stream for this URI can not be created.</DL>
</DD>
</DL>
<HR>
<A NAME="touchLeaf()"><!-- --></A><H3>
touchLeaf</H3>
<PRE>
void <B>touchLeaf</B>()
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>Creates a new, empty resource at the location identified by
the IURI. On completion, this.isLeaf() == true. If a leaf
resource already exists, this method does nothing. If a
non-leaf resource already exists under this IURI, creation
will fail and an exception will be thrown.
<P>
<DD><DL>
<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 an error occurs touching this leaf resource.</DL>
</DD>
</DL>
<HR>
<A NAME="touchFolder()"><!-- --></A><H3>
touchFolder</H3>
<PRE>
void <B>touchFolder</B>()
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>Creates a new folder resource at the location identified by
the IURI. The scheme of the IURI must be hierarchical.
On completion, this.isLeaf() == false. If a folder resource
already exists, this method does nothing. If a leaf resource
already exists under this IURI, creation will fail and an
exception will be thrown.
<P>
<DD><DL>
<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 an error occurs touching this folder resource.</DL>
</DD>
</DL>
<HR>
<A NAME="erase()"><!-- --></A><H3>
erase</H3>
<PRE>
void <B>erase</B>()
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>Erases the resource identified by this IURI.
<P>
<DD><DL>
<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 an error occurs erasing this resource.</DL>
</DD>
</DL>
<HR>
<A NAME="rename(org.eclipse.wst.common.environment.uri.IURI)"><!-- --></A><H3>
rename</H3>
<PRE>
void <B>rename</B>(<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A>&nbsp;newURI)
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>Renames or moves the resource identified by this IURI
to the new IURI.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>newURI</CODE> - the new URI name for this URI.
<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 an error occurs renaming this resource.</DL>
</DD>
</DL>
<HR>
<A NAME="visit(org.eclipse.wst.common.environment.uri.IURIVisitor)"><!-- --></A><H3>
visit</H3>
<PRE>
void <B>visit</B>(<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIVisitor.html" title="interface in org.eclipse.wst.common.environment.uri">IURIVisitor</A>&nbsp;uriVisitor)
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>Visits this resource and its decendants in pre-order fashion.
For each resource, whether a folder or a leaf, the given
IURIVisitor's visit() method is called with the IURI of the
resource. If IURIVisitor.visit() returns false, the visiting
algorithm will "prune" the decendants of the resource and
carry on visiting the rest of the tree. If IURIVisitor.visit()
returns true, the visiting algorithm will continue its walk
down the resource's descendants.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uriVisitor</CODE> - the visitor that will be called for each resource visited.
<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 an error occurs visiting this resource and its children.</DL>
</DD>
</DL>
<HR>
<A NAME="visit(org.eclipse.wst.common.environment.uri.IURIVisitor, org.eclipse.wst.common.environment.uri.IURIFilter)"><!-- --></A><H3>
visit</H3>
<PRE>
void <B>visit</B>(<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIVisitor.html" title="interface in org.eclipse.wst.common.environment.uri">IURIVisitor</A>&nbsp;uriVisitor,
<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIFilter.html" title="interface in org.eclipse.wst.common.environment.uri">IURIFilter</A>&nbsp;uriFilter)
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>As for visit(IURIVisitor), except only resource URIs that are
accepted by the given filter are visited. If a folder resource
fails to be accepted by the filter, this will not prevent the
visiting algorithm from walking the resource's descendants.
It remains the job of the visitor to choose whether or not to
prune a branch by returning false or true.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uriVisitor</CODE> - the visitor that will be called for each resource visited.<DD><CODE>uriFilter</CODE> - the resource filter.
<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 an error occurs visiting this resource and its children.</DL>
</DD>
</DL>
<HR>
<A NAME="list()"><!-- --></A><H3>
list</H3>
<PRE>
<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A>[] <B>list</B>()
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>Returns a list of URIs for the immediate children of the given
hierarchical, non-leaf IURI. This method never returns null,
though it may return a zero length array.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>returns the children for this URI.
<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 an error occurs locating the children for this URI.</DL>
</DD>
</DL>
<HR>
<A NAME="list(org.eclipse.wst.common.environment.uri.IURIFilter)"><!-- --></A><H3>
list</H3>
<PRE>
<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURI.html" title="interface in org.eclipse.wst.common.environment.uri">IURI</A>[] <B>list</B>(<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIFilter.html" title="interface in org.eclipse.wst.common.environment.uri">IURIFilter</A>&nbsp;uriFilter)
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>As for list(), except only URIs that are accepted by the given
filter are returned in the array. This method never returns null,
though it may return a zero length array.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uriFilter</CODE> - the child filter.
<DT><B>Returns:</B><DD>returns the filtered children for this URI.
<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 an error occurs locating the children for this URI.</DL>
</DD>
</DL>
<HR>
<A NAME="isAvailableAsURL()"><!-- --></A><H3>
isAvailableAsURL</H3>
<PRE>
boolean <B>isAvailableAsURL</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>Returns true if the asURL() method is fair game,
in other words, if this IURI can be converted into a URL.</DL>
</DD>
</DL>
<HR>
<A NAME="asURL()"><!-- --></A><H3>
asURL</H3>
<PRE>
java.net.URL <B>asURL</B>()
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>Returns:</B><DD>Returns a URL object for the resource under this IURI.
There are many URIs and URISchemes for which this method
will fail and throw an exception. It should be used only
in cases where URIs are known to be representable as URLs.
<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 an error occurs returning this URL.</DL>
</DD>
</DL>
<HR>
<A NAME="isAvailableAsFile()"><!-- --></A><H3>
isAvailableAsFile</H3>
<PRE>
boolean <B>isAvailableAsFile</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>Returns true if the asFile() method is fair game,
in other words, if this IURI can be converted into a File.</DL>
</DD>
</DL>
<HR>
<A NAME="asFile()"><!-- --></A><H3>
asFile</H3>
<PRE>
java.io.File <B>asFile</B>()
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>Returns:</B><DD>Returns a File object for the resource under this IURI.
There are many URIs and URISchemes for which this method
will fail and throw an exception. It should be used only
in cases where URIs are known to be backed by physical files.
<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 an error occurs returning this File.</DL>
</DD>
</DL>
<HR>
<A NAME="asString()"><!-- --></A><H3>
asString</H3>
<PRE>
java.lang.String <B>asString</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>Returns the IURI as a string.
Equivalent to toString().</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;<A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IURI.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;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../../../org/eclipse/wst/common/environment/uri/IURIFactory.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/IURI.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IURI.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>