Jump to: navigation, search

Difference between revisions of "FAQ How do I find out the install location of a plug-in?"

 
m
Line 4: Line 4:
 
These URLs use a special Eclipse Platform protocol, but if you are
 
These URLs use a special Eclipse Platform protocol, but if you are
 
using them only to read files, it does not matter.  
 
using them only to read files, it does not matter.  
 
 
 
  
 
The following snippet  
 
The following snippet  
 
opens an input stream on a file called <tt>sample.gif</tt> located  
 
opens an input stream on a file called <tt>sample.gif</tt> located  
 
in a subdirectory, called <tt>icons</tt>, of a plug-in&#146;s install directory:
 
in a subdirectory, called <tt>icons</tt>, of a plug-in&#146;s install directory:
 +
 
<pre>
 
<pre>
 
   Bundle bundle = Platform.getBundle(yourPluginId);
 
   Bundle bundle = Platform.getBundle(yourPluginId);
Line 17: Line 15:
 
   InputStream in = fileURL.openStream();
 
   InputStream in = fileURL.openStream();
 
</pre>
 
</pre>
 
 
  
 
If you need to know the file system location of a plug-in, you need to  
 
If you need to know the file system location of a plug-in, you need to  
Line 27: Line 23:
 
must exist in the local file system, so you cannot rely on this
 
must exist in the local file system, so you cannot rely on this
 
method&#146;s returning a file system URL under all circumstances in the future.
 
method&#146;s returning a file system URL under all circumstances in the future.
 
 
 
 
 
  
 
== See Also: ==
 
== See Also: ==
 
+
*[[FAQ_Where_do_plug-ins_store_their_state%3F]]
 
+
[[FAQ_Where_do_plug-ins_store_their_state%3F]]
+
  
 
<hr><font size=-2>This FAQ was originally published in [http://www.eclipsefaq.org Official Eclipse 3.0 FAQs]. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the [http://www.eclipse.org/legal/epl-v10.html Eclipse Public License v1.0].</font>
 
<hr><font size=-2>This FAQ was originally published in [http://www.eclipsefaq.org Official Eclipse 3.0 FAQs]. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the [http://www.eclipse.org/legal/epl-v10.html Eclipse Public License v1.0].</font>

Revision as of 22:06, 29 May 2006

You should generally avoid making assumptions about the location of a plug-in at runtime. To find resources, such as images, that are stored in your plug-in’s install directory, you can use URLs provided by the Platform class. These URLs use a special Eclipse Platform protocol, but if you are using them only to read files, it does not matter.

The following snippet opens an input stream on a file called sample.gif located in a subdirectory, called icons, of a plug-in’s install directory:

   Bundle bundle = Platform.getBundle(yourPluginId);
   Path path = new Path("icons/sample.gif");
   URL fileURL = Platform.find(bundle, path);
   InputStream in = fileURL.openStream();

If you need to know the file system location of a plug-in, you need to use Platform.resolve(URL). This method converts a platform URL to a standard URL protocol, such as HyperText Transfer Protocol (HTTP), or file. Note that the Eclipse Platform does not specify that plug-ins must exist in the local file system, so you cannot rely on this method’s returning a file system URL under all circumstances in the future.

See Also:


This FAQ was originally published in Official Eclipse 3.0 FAQs. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the Eclipse Public License v1.0.