source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/sound/SoundTask.BuildAlert.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 13.5 KB
Line 
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.4.2_13) on Mon Oct 01 14:33:30 NZST 2007 -->
6<TITLE>
7SoundTask.BuildAlert (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.sound.SoundTask.BuildAlert class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="SoundTask.BuildAlert (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sound/SoundTask.html" title="class in org.apache.tools.ant.taskdefs.optional.sound"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;NEXT CLASS</FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="SoundTask.BuildAlert.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs.optional.sound</FONT>
85<BR>
86Class SoundTask.BuildAlert</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.sound.SoundTask.BuildAlert</B>
90</PRE>
91<DL>
92<DT><B>Enclosing class:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sound/SoundTask.html" title="class in org.apache.tools.ant.taskdefs.optional.sound">SoundTask</A></DD>
93</DL>
94<HR>
95<DL>
96<DT>public class <B>SoundTask.BuildAlert</B><DT>extends java.lang.Object</DL>
97
98<P>
99A class to be extended by any BuildAlert's that require the output
100 of sound.
101<P>
102
103<P>
104<HR>
105
106<P>
107<!-- ======== NESTED CLASS SUMMARY ======== -->
108
109
110<!-- =========== FIELD SUMMARY =========== -->
111
112
113<!-- ======== CONSTRUCTOR SUMMARY ======== -->
114
115<A NAME="constructor_summary"><!-- --></A>
116<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
117<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
118<TD COLSPAN=2><FONT SIZE="+2">
119<B>Constructor Summary</B></FONT></TD>
120</TR>
121<TR BGCOLOR="white" CLASS="TableRowColor">
122<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sound/SoundTask.BuildAlert.html#SoundTask.BuildAlert()">SoundTask.BuildAlert</A></B>()</CODE>
123
124<BR>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
126</TR>
127</TABLE>
128&nbsp;
129<!-- ========== METHOD SUMMARY =========== -->
130
131<A NAME="method_summary"><!-- --></A>
132<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
133<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
134<TD COLSPAN=2><FONT SIZE="+2">
135<B>Method Summary</B></FONT></TD>
136</TR>
137<TR BGCOLOR="white" CLASS="TableRowColor">
138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139<CODE>&nbsp;java.lang.Long</CODE></FONT></TD>
140<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sound/SoundTask.BuildAlert.html#getDuration()">getDuration</A></B>()</CODE>
141
142<BR>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the duration in milliseconds the file should be played.</TD>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147<CODE>&nbsp;int</CODE></FONT></TD>
148<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sound/SoundTask.BuildAlert.html#getLoops()">getLoops</A></B>()</CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the number of times the source file should be played.</TD>
152</TR>
153<TR BGCOLOR="white" CLASS="TableRowColor">
154<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155<CODE>&nbsp;java.io.File</CODE></FONT></TD>
156<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sound/SoundTask.BuildAlert.html#getSource()">getSource</A></B>()</CODE>
157
158<BR>
159&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the location of the file to get the audio.</TD>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163<CODE>&nbsp;void</CODE></FONT></TD>
164<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sound/SoundTask.BuildAlert.html#setDuration(java.lang.Long)">setDuration</A></B>(java.lang.Long&nbsp;duration)</CODE>
165
166<BR>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the duration in milliseconds the file should be played; optional.</TD>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<CODE>&nbsp;void</CODE></FONT></TD>
172<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sound/SoundTask.BuildAlert.html#setLoops(int)">setLoops</A></B>(int&nbsp;loops)</CODE>
173
174<BR>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the number of times the source file should be played; optional.</TD>
176</TR>
177<TR BGCOLOR="white" CLASS="TableRowColor">
178<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179<CODE>&nbsp;void</CODE></FONT></TD>
180<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sound/SoundTask.BuildAlert.html#setSource(java.io.File)">setSource</A></B>(java.io.File&nbsp;source)</CODE>
181
182<BR>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the location of the file to get the audio; required.</TD>
184</TR>
185</TABLE>
186&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
187<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
188<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
189<TD><B>Methods inherited from class java.lang.Object</B></TD>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
193</TR>
194</TABLE>
195&nbsp;
196<P>
197
198<!-- ============ FIELD DETAIL =========== -->
199
200
201<!-- ========= CONSTRUCTOR DETAIL ======== -->
202
203<A NAME="constructor_detail"><!-- --></A>
204<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
205<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
206<TD COLSPAN=1><FONT SIZE="+2">
207<B>Constructor Detail</B></FONT></TD>
208</TR>
209</TABLE>
210
211<A NAME="SoundTask.BuildAlert()"><!-- --></A><H3>
212SoundTask.BuildAlert</H3>
213<PRE>
214public <B>SoundTask.BuildAlert</B>()</PRE>
215<DL>
216</DL>
217
218<!-- ============ METHOD DETAIL ========== -->
219
220<A NAME="method_detail"><!-- --></A>
221<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
222<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
223<TD COLSPAN=1><FONT SIZE="+2">
224<B>Method Detail</B></FONT></TD>
225</TR>
226</TABLE>
227
228<A NAME="setDuration(java.lang.Long)"><!-- --></A><H3>
229setDuration</H3>
230<PRE>
231public void <B>setDuration</B>(java.lang.Long&nbsp;duration)</PRE>
232<DL>
233<DD>Sets the duration in milliseconds the file should be played; optional.
234<P>
235<DD><DL>
236</DL>
237</DD>
238</DL>
239<HR>
240
241<A NAME="setSource(java.io.File)"><!-- --></A><H3>
242setSource</H3>
243<PRE>
244public void <B>setSource</B>(java.io.File&nbsp;source)</PRE>
245<DL>
246<DD>Sets the location of the file to get the audio; required.
247<P>
248<DD><DL>
249<DT><B>Parameters:</B><DD><CODE>source</CODE> - the name of a sound-file directory or of the audio file</DL>
250</DD>
251</DL>
252<HR>
253
254<A NAME="setLoops(int)"><!-- --></A><H3>
255setLoops</H3>
256<PRE>
257public void <B>setLoops</B>(int&nbsp;loops)</PRE>
258<DL>
259<DD>Sets the number of times the source file should be played; optional.
260<P>
261<DD><DL>
262<DT><B>Parameters:</B><DD><CODE>loops</CODE> - the number of loops to play the source file</DL>
263</DD>
264</DL>
265<HR>
266
267<A NAME="getSource()"><!-- --></A><H3>
268getSource</H3>
269<PRE>
270public java.io.File <B>getSource</B>()</PRE>
271<DL>
272<DD>Gets the location of the file to get the audio.
273<P>
274<DD><DL>
275</DL>
276</DD>
277</DL>
278<HR>
279
280<A NAME="getLoops()"><!-- --></A><H3>
281getLoops</H3>
282<PRE>
283public int <B>getLoops</B>()</PRE>
284<DL>
285<DD>Sets the number of times the source file should be played.
286<P>
287<DD><DL>
288
289<DT><B>Returns:</B><DD>the number of loops to play the source file</DL>
290</DD>
291</DL>
292<HR>
293
294<A NAME="getDuration()"><!-- --></A><H3>
295getDuration</H3>
296<PRE>
297public java.lang.Long <B>getDuration</B>()</PRE>
298<DL>
299<DD>Gets the duration in milliseconds the file should be played.
300<P>
301<DD><DL>
302</DL>
303</DD>
304</DL>
305<!-- ========= END OF CLASS DATA ========= -->
306<HR>
307
308
309<!-- ======= START OF BOTTOM NAVBAR ====== -->
310<A NAME="navbar_bottom"><!-- --></A>
311<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
312<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
313<TR>
314<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
315<A NAME="navbar_bottom_firstrow"><!-- --></A>
316<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
317 <TR ALIGN="center" VALIGN="top">
318 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
319 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
320 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
321 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
322 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
323 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
324 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
325 </TR>
326</TABLE>
327</TD>
328<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
329</EM>
330</TD>
331</TR>
332
333<TR>
334<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
335&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sound/SoundTask.html" title="class in org.apache.tools.ant.taskdefs.optional.sound"><B>PREV CLASS</B></A>&nbsp;
336&nbsp;NEXT CLASS</FONT></TD>
337<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
338 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
339&nbsp;<A HREF="SoundTask.BuildAlert.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
340&nbsp;<SCRIPT type="text/javascript">
341 <!--
342 if(window==top) {
343 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
344 }
345 //-->
346</SCRIPT>
347<NOSCRIPT>
348 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
349</NOSCRIPT>
350
351</FONT></TD>
352</TR>
353<TR>
354<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
355 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
356<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
357DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
358</TR>
359</TABLE>
360<A NAME="skip-navbar_bottom"></A>
361<!-- ======== END OF BOTTOM NAVBAR ======= -->
362
363<HR>
364Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
365</BODY>
366</HTML>
Note: See TracBrowser for help on using the repository browser.