← Back to branch summary

~ubuntu-branches/ubuntu/utopic/libisrt-java/utopic

« back to all changes in this revision

Viewing changes to javadoc/de/intarsys/tools/installresource/InstallFile.html

  • Committer: Package Import Robot
  • Author(s): Torsten Werner
  • Date: 2011-08-31 17:16:54 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: package-import@ubuntu.com-20110831171654-i306ydrg00gribvc
Tags: 4.8.20100629-1
* Team upload
* New upstream release
* Improve downloading / creating the orig tarball. Remove javadoc files.
* Switch to javahelper.
* Drop versioned package libisrt-4.7-java.
* Switch to debhelper level 7.
* Update Standards-Version: 3.9.1.
* Switch to source format 3.0.

Show diffs side-by-side

added added

removed removed

Lines of Context:
javadoc/de/intarsys/tools/installresource/InstallFile.html
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 Mon Nov 02 09:43:05 CET 2009 -->
6
 
<TITLE>
7
 
InstallFile (intarsys runtime library)
8
 
</TITLE>
9
 
 
10
 
<META NAME="keywords" CONTENT="de.intarsys.tools.installresource.InstallFile class">
11
 
 
12
 
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../javadocstyle.css" TITLE="Style">
13
 
 
14
 
<SCRIPT type="text/javascript">
15
 
function windowTitle()
16
 
{
17
 
    parent.document.title="InstallFile (intarsys runtime library)";
18
 
}
19
 
</SCRIPT>
20
 
<NOSCRIPT>
21
 
</NOSCRIPT>
22
 
 
23
 
</HEAD>
24
 
 
25
 
<BODY BGCOLOR="white" onload="windowTitle();">
26
 
 
27
 
 
28
 
<!-- ========= START OF TOP NAVBAR ======= -->
29
 
<A NAME="navbar_top"><!-- --></A>
30
 
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
31
 
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
32
 
<TR>
33
 
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
34
 
<A NAME="navbar_top_firstrow"><!-- --></A>
35
 
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
36
 
  <TR ALIGN="center" VALIGN="top">
37
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
38
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
39
 
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
40
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/InstallFile.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
41
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
42
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
43
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
44
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
45
 
  </TR>
46
 
</TABLE>
47
 
</TD>
48
 
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
49
 
 
50
 
                                <i>
51
 
                                <b>intarsys runtime library</b>
52
 
                        </i>
53
 
                        </EM>
54
 
</TD>
55
 
</TR>
56
 
 
57
 
<TR>
58
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
59
 
&nbsp;<A HREF="../../../../de/intarsys/tools/installresource/Install.html" title="class in de.intarsys.tools.installresource"><B>PREV CLASS</B></A>&nbsp;
60
 
&nbsp;<A HREF="../../../../de/intarsys/tools/installresource/InstallFileList.html" title="class in de.intarsys.tools.installresource"><B>NEXT CLASS</B></A></FONT></TD>
61
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
62
 
  <A HREF="../../../../index.html?de/intarsys/tools/installresource/InstallFile.html" target="_top"><B>FRAMES</B></A>  &nbsp;
63
 
&nbsp;<A HREF="InstallFile.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
64
 
&nbsp;<SCRIPT type="text/javascript">
65
 
  <!--
66
 
  if(window==top) {
67
 
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
68
 
  }
69
 
  //-->
70
 
</SCRIPT>
71
 
<NOSCRIPT>
72
 
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
73
 
</NOSCRIPT>
74
 
 
75
 
 
76
 
</FONT></TD>
77
 
</TR>
78
 
<TR>
79
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80
 
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_de.intarsys.tools.installresource.Install">METHOD</A></FONT></TD>
81
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
82
 
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
83
 
</TR>
84
 
</TABLE>
85
 
<A NAME="skip-navbar_top"></A>
86
 
<!-- ========= END OF TOP NAVBAR ========= -->
87
 
 
88
 
<HR>
89
 
<!-- ======== START OF CLASS DATA ======== -->
90
 
<H2>
91
 
<FONT SIZE="-1">
92
 
de.intarsys.tools.installresource</FONT>
93
 
<BR>
94
 
Class InstallFile</H2>
95
 
<PRE>
96
 
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
97
 
  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../de/intarsys/tools/installresource/Install.html" title="class in de.intarsys.tools.installresource">de.intarsys.tools.installresource.Install</A>
98
 
      <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>de.intarsys.tools.installresource.InstallFile</B>
99
 
</PRE>
100
 
<HR>
101
 
<DL>
102
 
<DT><PRE>public class <B>InstallFile</B><DT>extends <A HREF="../../../../de/intarsys/tools/installresource/Install.html" title="class in de.intarsys.tools.installresource">Install</A></DL>
103
 
</PRE>
104
 
 
105
 
<P>
106
 
An abstraction to access a file to be deployed along with the application via
107
 
 the class loader.
108
 
 <p>
109
 
 The file is searched in the class loader with getResourceAsStream(x) where x
110
 
 is one of
111
 
 <ul>
112
 
 <li> [path]/[os.name]-[os.arch]/[filename] </li>
113
 
 <li> [path]/[os.short name]-[os.arch]/[filename] </li>
114
 
 <li> [path]/default/[filename] </li>
115
 
 </ul>
116
 
 
117
 
 where
118
 
 
119
 
 <ul>
120
 
 <li> [path] is a path prefix defined upon object creation </li>
121
 
 <li> [os.name] is the System property os.name in lowercase</li>
122
 
 <li> [os.short name] is derived from the System property os.name by using the
123
 
 beginning up to the first whitespace in lowercase</li>
124
 
 <li> [os.arch] is the System property os.arch in lowercase</li>
125
 
 <li> [filename] is the name defined upon object creation</li>
126
 
 </ul>
127
 
 
128
 
 example, with NativeCode("foo", "bar.dll") on a Windows Vista machine you
129
 
 will search for:
130
 
 
131
 
 <ul>
132
 
 <li>foo/windows vista-x86/bar.dll</li>
133
 
 <li>foo/windows-x86/bar.dll</li>
134
 
 <li>foo/default/bar.dll</li>
135
 
 </ul>
136
 
<P>
137
 
 
138
 
<P>
139
 
<HR>
140
 
 
141
 
<P>
142
 
 
143
 
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
144
 
 
145
 
<A NAME="constructor_summary"><!-- --></A>
146
 
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
147
 
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
148
 
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
149
 
<B>Constructor Summary</B></FONT></TH>
150
 
</TR>
151
 
<TR BGCOLOR="white" CLASS="TableRowColor">
152
 
<TD><CODE><B><A HREF="../../../../de/intarsys/tools/installresource/InstallFile.html#InstallFile(java.lang.String, java.lang.String, boolean)">InstallFile</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;path,
153
 
            <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name,
154
 
            boolean&nbsp;platformDependent)</CODE>
155
 
 
156
 
<BR>
157
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
158
 
</TR>
159
 
</TABLE>
160
 
&nbsp;
161
 
<!-- ========== METHOD SUMMARY =========== -->
162
 
 
163
 
<A NAME="method_summary"><!-- --></A>
164
 
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
165
 
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
166
 
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
167
 
<B>Method Summary</B></FONT></TH>
168
 
</TR>
169
 
</TABLE>
170
 
&nbsp;<A NAME="methods_inherited_from_class_de.intarsys.tools.installresource.Install"><!-- --></A>
171
 
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
172
 
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
173
 
<TH ALIGN="left"><B>Methods inherited from class de.intarsys.tools.installresource.<A HREF="../../../../de/intarsys/tools/installresource/Install.html" title="class in de.intarsys.tools.installresource">Install</A></B></TH>
174
 
</TR>
175
 
<TR BGCOLOR="white" CLASS="TableRowColor">
176
 
<TD><CODE><A HREF="../../../../de/intarsys/tools/installresource/Install.html#delete()">delete</A>, <A HREF="../../../../de/intarsys/tools/installresource/Install.html#getClassLoader()">getClassLoader</A>, <A HREF="../../../../de/intarsys/tools/installresource/Install.html#getFile()">getFile</A>, <A HREF="../../../../de/intarsys/tools/installresource/Install.html#getFiles()">getFiles</A>, <A HREF="../../../../de/intarsys/tools/installresource/Install.html#getName()">getName</A>, <A HREF="../../../../de/intarsys/tools/installresource/Install.html#getPath()">getPath</A>, <A HREF="../../../../de/intarsys/tools/installresource/Install.html#getPlatformDefaultId()">getPlatformDefaultId</A>, <A HREF="../../../../de/intarsys/tools/installresource/Install.html#getPlatformFallbackId()">getPlatformFallbackId</A>, <A HREF="../../../../de/intarsys/tools/installresource/Install.html#getPlatformId()">getPlatformId</A>, <A HREF="../../../../de/intarsys/tools/installresource/Install.html#isPlatformDependent()">isPlatformDependent</A>, <A HREF="../../../../de/intarsys/tools/installresource/Install.html#load()">load</A>, <A HREF="../../../../de/intarsys/tools/installresource/Install.html#loadAll()">loadAll</A>, <A HREF="../../../../de/intarsys/tools/installresource/Install.html#setClassLoader(java.lang.ClassLoader)">setClassLoader</A>, <A HREF="../../../../de/intarsys/tools/installresource/Install.html#setPlatformFallbackId(java.lang.String)">setPlatformFallbackId</A>, <A HREF="../../../../de/intarsys/tools/installresource/Install.html#setPlatformId(java.lang.String)">setPlatformId</A></CODE></TD>
177
 
</TR>
178
 
</TABLE>
179
 
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
180
 
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
181
 
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
182
 
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
183
 
</TR>
184
 
<TR BGCOLOR="white" CLASS="TableRowColor">
185
 
<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
186
 
</TR>
187
 
</TABLE>
188
 
&nbsp;
189
 
<P>
190
 
 
191
 
<!-- ========= CONSTRUCTOR DETAIL ======== -->
192
 
 
193
 
<A NAME="constructor_detail"><!-- --></A>
194
 
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
195
 
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
196
 
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
197
 
<B>Constructor Detail</B></FONT></TH>
198
 
</TR>
199
 
</TABLE>
200
 
 
201
 
<A NAME="InstallFile(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
202
 
InstallFile</H3>
203
 
<PRE>
204
 
public <B>InstallFile</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;path,
205
 
                   <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name,
206
 
                   boolean&nbsp;platformDependent)</PRE>
207
 
<DL>
208
 
</DL>
209
 
<!-- ========= END OF CLASS DATA ========= -->
210
 
<HR>
211
 
 
212
 
 
213
 
<!-- ======= START OF BOTTOM NAVBAR ====== -->
214
 
<A NAME="navbar_bottom"><!-- --></A>
215
 
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
216
 
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
217
 
<TR>
218
 
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
219
 
<A NAME="navbar_bottom_firstrow"><!-- --></A>
220
 
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
221
 
  <TR ALIGN="center" VALIGN="top">
222
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
223
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
224
 
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
225
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/InstallFile.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
226
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
227
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
228
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
229
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
230
 
  </TR>
231
 
</TABLE>
232
 
</TD>
233
 
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
234
 
 
235
 
                                <i>
236
 
                                <b>intarsys runtime library</b>
237
 
                        </i>
238
 
                        </EM>
239
 
</TD>
240
 
</TR>
241
 
 
242
 
<TR>
243
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
244
 
&nbsp;<A HREF="../../../../de/intarsys/tools/installresource/Install.html" title="class in de.intarsys.tools.installresource"><B>PREV CLASS</B></A>&nbsp;
245
 
&nbsp;<A HREF="../../../../de/intarsys/tools/installresource/InstallFileList.html" title="class in de.intarsys.tools.installresource"><B>NEXT CLASS</B></A></FONT></TD>
246
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
247
 
  <A HREF="../../../../index.html?de/intarsys/tools/installresource/InstallFile.html" target="_top"><B>FRAMES</B></A>  &nbsp;
248
 
&nbsp;<A HREF="InstallFile.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
249
 
&nbsp;<SCRIPT type="text/javascript">
250
 
  <!--
251
 
  if(window==top) {
252
 
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
253
 
  }
254
 
  //-->
255
 
</SCRIPT>
256
 
<NOSCRIPT>
257
 
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
258
 
</NOSCRIPT>
259
 
 
260
 
 
261
 
</FONT></TD>
262
 
</TR>
263
 
<TR>
264
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
265
 
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_de.intarsys.tools.installresource.Install">METHOD</A></FONT></TD>
266
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
267
 
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
268
 
</TR>
269
 
</TABLE>
270
 
<A NAME="skip-navbar_bottom"></A>
271
 
<!-- ======== END OF BOTTOM NAVBAR ======= -->
272
 
 
273
 
<HR>
274
 
 
275
 
                                <i>Copyright &#169; 2008 <a href=http://www.intarsys.de/ target=_top>intarsys consulting GmbH</a>. All Rights Reserved.</i>
276
 
                        
277
 
</BODY>
278
 
</HTML>