Context Navigation

source: Dev/branches/play-2.0.1/documentation/api/java/play/Application.html @ 322

Last change on this file since 322 was 322, checked in by hendrikvanantwerpen, 13 years ago
Added Play! framework and application with Jena dependency. Working on the basic things now (login/register), after that start implementing our data model.
File size: 16.7 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.6.0_29) on Wed May 02 16:04:58 CEST 2012 -->
6	<TITLE>
7	Application (playframework)
8	</TITLE>
9
10	<META NAME="date" CONTENT="2012-05-02">
11
12	<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style">
13
14	<SCRIPT type="text/javascript">
15	function windowTitle()
16	{
17	if (location.href.indexOf('is-external=true') == -1) {
18	parent.document.title="Application (playframework)";
19	}
20	}
21	</SCRIPT>
22	<NOSCRIPT>
23	</NOSCRIPT>
24
25	</HEAD>
26
27	<BODY BGCOLOR="white" onload="windowTitle();">
28	<HR>
29
30
31	<!-- ========= START OF TOP NAVBAR ======= -->
32	<A NAME="navbar_top"><!-- --></A>
33	<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35	<TR>
36	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37	<A NAME="navbar_top_firstrow"><!-- --></A>
38	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39	<TR ALIGN="center" VALIGN="top">
40	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
41	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
42	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
43	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
44	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
45	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
46	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
47	</TR>
48	</TABLE>
49	</TD>
50	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51	</EM>
52	</TD>
53	</TR>
54
55	<TR>
56	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57	PREV CLASS
58	<A HREF="../play/Configuration.html" title="class in play"><B>NEXT CLASS</B></A></FONT></TD>
59	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60	<A HREF="../index.html?play/Application.html" target="_top"><B>FRAMES</B></A>
61	<A HREF="Application.html" target="_top"><B>NO FRAMES</B></A>
62	<SCRIPT type="text/javascript">
63	<!--
64	if(window==top) {
65	document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
66	}
67	//-->
68	</SCRIPT>
69	<NOSCRIPT>
70	<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
71	</NOSCRIPT>
72
73
74	</FONT></TD>
75	</TR>
76	<TR>
77	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78	SUMMARY: NESTED \| FIELD \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
79	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80	DETAIL: FIELD \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
81	</TR>
82	</TABLE>
83	<A NAME="skip-navbar_top"></A>
84	<!-- ========= END OF TOP NAVBAR ========= -->
85
86	<HR>
87	<!-- ======== START OF CLASS DATA ======== -->
88	<H2>
89	<FONT SIZE="-1">
90	play</FONT>
91	<BR>
92	Class Application</H2>
93	<PRE>
94	java.lang.Object
95	<IMG SRC="../resources/inherit.gif" ALT="extended by "><B>play.Application</B>
96	</PRE>
97	<HR>
98	<DL>
99	<DT><PRE>public class <B>Application</B><DT>extends java.lang.Object</DL>
100	</PRE>
101
102	<P>
103	A Play application.
104	<p>
105	Application creation is handled by the framework engine.
106	<P>
107
108	<P>
109	<HR>
110
111	<P>
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	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
119	<B>Constructor Summary</B></FONT></TH>
120	</TR>
121	<TR BGCOLOR="white" CLASS="TableRowColor">
122	<TD><CODE><B><A HREF="../play/Application.html#Application(play.api.Application)">Application</A></B>(play.api.Application application)</CODE>
123
124	<BR>
125	Creates an application from a Scala Application value.</TD>
126	</TR>
127	</TABLE>
128
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	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
135	<B>Method Summary</B></FONT></TH>
136	</TR>
137	<TR BGCOLOR="white" CLASS="TableRowColor">
138	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139	<CODE> java.lang.ClassLoader</CODE></FONT></TD>
140	<TD><CODE><B><A HREF="../play/Application.html#classloader()">classloader</A></B>()</CODE>
141
142	<BR>
143	Retrieves the application classloader.</TD>
144	</TR>
145	<TR BGCOLOR="white" CLASS="TableRowColor">
146	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147	<CODE> <A HREF="../play/Configuration.html" title="class in play">Configuration</A></CODE></FONT></TD>
148	<TD><CODE><B><A HREF="../play/Application.html#configuration()">configuration</A></B>()</CODE>
149
150	<BR>
151	Retrieves the application configuration/</TD>
152	</TR>
153	<TR BGCOLOR="white" CLASS="TableRowColor">
154	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155	<CODE> java.io.File</CODE></FONT></TD>
156	<TD><CODE><B><A HREF="../play/Application.html#getFile(java.lang.String)">getFile</A></B>(java.lang.String relativePath)</CODE>
157
158	<BR>
159	Retrieves a file relative to the application root path.</TD>
160	</TR>
161	<TR BGCOLOR="white" CLASS="TableRowColor">
162	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163	<CODE> java.util.Set<java.lang.String></CODE></FONT></TD>
164	<TD><CODE><B><A HREF="../play/Application.html#getTypesAnnotatedWith(java.lang.String, java.lang.Class)">getTypesAnnotatedWith</A></B>(java.lang.String packageName,
165	java.lang.Class<? extends java.lang.annotation.Annotation> annotation)</CODE>
166
167	<BR>
168	Scans the application classloader to retrieve all types annotated with a specific annotation.</TD>
169	</TR>
170	<TR BGCOLOR="white" CLASS="TableRowColor">
171	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
172	<CODE> boolean</CODE></FONT></TD>
173	<TD><CODE><B><A HREF="../play/Application.html#isDev()">isDev</A></B>()</CODE>
174
175	<BR>
176	Returns `true` if the application is `DEV` mode.</TD>
177	</TR>
178	<TR BGCOLOR="white" CLASS="TableRowColor">
179	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
180	<CODE> boolean</CODE></FONT></TD>
181	<TD><CODE><B><A HREF="../play/Application.html#isProd()">isProd</A></B>()</CODE>
182
183	<BR>
184	Returns `true` if the application is `PROD` mode.</TD>
185	</TR>
186	<TR BGCOLOR="white" CLASS="TableRowColor">
187	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188	<CODE> boolean</CODE></FONT></TD>
189	<TD><CODE><B><A HREF="../play/Application.html#isTest()">isTest</A></B>()</CODE>
190
191	<BR>
192	Returns `true` if the application is `TEST` mode.</TD>
193	</TR>
194	<TR BGCOLOR="white" CLASS="TableRowColor">
195	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196	<CODE> java.io.File</CODE></FONT></TD>
197	<TD><CODE><B><A HREF="../play/Application.html#path()">path</A></B>()</CODE>
198
199	<BR>
200	Retrieves the application path.</TD>
201	</TR>
202	<TR BGCOLOR="white" CLASS="TableRowColor">
203	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204	<CODE>
205	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
206	<TR ALIGN="right" VALIGN="">
207	<TD NOWRAP><FONT SIZE="-1">
208	<CODE><T> T</CODE></FONT></TD>
209	</TR>
210	</TABLE>
211	</CODE></FONT></TD>
212	<TD><CODE><B><A HREF="../play/Application.html#plugin(java.lang.Class)">plugin</A></B>(java.lang.Class<T> pluginClass)</CODE>
213
214	<BR>
215	Retrieve the plugin instance for the class.</TD>
216	</TR>
217	<TR BGCOLOR="white" CLASS="TableRowColor">
218	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
219	<CODE> java.net.URL</CODE></FONT></TD>
220	<TD><CODE><B><A HREF="../play/Application.html#resource(java.lang.String)">resource</A></B>(java.lang.String relativePath)</CODE>
221
222	<BR>
223	Retrieves a resource from the classpath.</TD>
224	</TR>
225	<TR BGCOLOR="white" CLASS="TableRowColor">
226	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
227	<CODE> java.io.InputStream</CODE></FONT></TD>
228	<TD><CODE><B><A HREF="../play/Application.html#resourceAsStream(java.lang.String)">resourceAsStream</A></B>(java.lang.String relativePath)</CODE>
229
230	<BR>
231	Retrieves a resource stream from the classpath.</TD>
232	</TR>
233	</TABLE>
234	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
235	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
236	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
237	<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
238	</TR>
239	<TR BGCOLOR="white" CLASS="TableRowColor">
240	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
241	</TR>
242	</TABLE>
243
244	<P>
245
246	<!-- ========= CONSTRUCTOR DETAIL ======== -->
247
248	<A NAME="constructor_detail"><!-- --></A>
249	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
250	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
251	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
252	<B>Constructor Detail</B></FONT></TH>
253	</TR>
254	</TABLE>
255
256	<A NAME="Application(play.api.Application)"><!-- --></A><H3>
257	Application</H3>
258	<PRE>
259	public <B>Application</B>(play.api.Application application)</PRE>
260	<DL>
261	<DD>Creates an application from a Scala Application value.
262	<P>
263	</DL>
264
265	<!-- ============ METHOD DETAIL ========== -->
266
267	<A NAME="method_detail"><!-- --></A>
268	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
269	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
270	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
271	<B>Method Detail</B></FONT></TH>
272	</TR>
273	</TABLE>
274
275	<A NAME="path()"><!-- --></A><H3>
276	path</H3>
277	<PRE>
278	public java.io.File <B>path</B>()</PRE>
279	<DL>
280	<DD>Retrieves the application path.
281	<p>
282	<P>
283	<DD><DL>
284
285	<DT><B>Returns:</B><DD>the application path</DL>
286	</DD>
287	</DL>
288	<HR>
289
290	<A NAME="configuration()"><!-- --></A><H3>
291	configuration</H3>
292	<PRE>
293	public <A HREF="../play/Configuration.html" title="class in play">Configuration</A> <B>configuration</B>()</PRE>
294	<DL>
295	<DD>Retrieves the application configuration/
296	<p>
297	<P>
298	<DD><DL>
299
300	<DT><B>Returns:</B><DD>the application path</DL>
301	</DD>
302	</DL>
303	<HR>
304
305	<A NAME="classloader()"><!-- --></A><H3>
306	classloader</H3>
307	<PRE>
308	public java.lang.ClassLoader <B>classloader</B>()</PRE>
309	<DL>
310	<DD>Retrieves the application classloader.
311	<p>
312	<P>
313	<DD><DL>
314
315	<DT><B>Returns:</B><DD>the application classloader</DL>
316	</DD>
317	</DL>
318	<HR>
319
320	<A NAME="getFile(java.lang.String)"><!-- --></A><H3>
321	getFile</H3>
322	<PRE>
323	public java.io.File <B>getFile</B>(java.lang.String relativePath)</PRE>
324	<DL>
325	<DD>Retrieves a file relative to the application root path.
326	<P>
327	<DD><DL>
328	<DT><B>Parameters:</B><DD><CODE>relativePath</CODE> - relative path of the file to fetch
329	<DT><B>Returns:</B><DD>a file instance - it is not guaranteed that the file exists</DL>
330	</DD>
331	</DL>
332	<HR>
333
334	<A NAME="resource(java.lang.String)"><!-- --></A><H3>
335	resource</H3>
336	<PRE>
337	public java.net.URL <B>resource</B>(java.lang.String relativePath)</PRE>
338	<DL>
339	<DD>Retrieves a resource from the classpath.
340	<P>
341	<DD><DL>
342	<DT><B>Parameters:</B><DD><CODE>relativePath</CODE> - relative path of the resource to fetch
343	<DT><B>Returns:</B><DD>URL to the resource (may be null)</DL>
344	</DD>
345	</DL>
346	<HR>
347
348	<A NAME="resourceAsStream(java.lang.String)"><!-- --></A><H3>
349	resourceAsStream</H3>
350	<PRE>
351	public java.io.InputStream <B>resourceAsStream</B>(java.lang.String relativePath)</PRE>
352	<DL>
353	<DD>Retrieves a resource stream from the classpath.
354	<P>
355	<DD><DL>
356	<DT><B>Parameters:</B><DD><CODE>relativePath</CODE> - relative path of the resource to fetch
357	<DT><B>Returns:</B><DD>InputStream to the resource (may be null)</DL>
358	</DD>
359	</DL>
360	<HR>
361
362	<A NAME="plugin(java.lang.Class)"><!-- --></A><H3>
363	plugin</H3>
364	<PRE>
365	public <T> T <B>plugin</B>(java.lang.Class<T> pluginClass)</PRE>
366	<DL>
367	<DD>Retrieve the plugin instance for the class.
368	<P>
369	<DD><DL>
370	</DL>
371	</DD>
372	</DL>
373	<HR>
374
375	<A NAME="getTypesAnnotatedWith(java.lang.String, java.lang.Class)"><!-- --></A><H3>
376	getTypesAnnotatedWith</H3>
377	<PRE>
378	public java.util.Set<java.lang.String> <B>getTypesAnnotatedWith</B>(java.lang.String packageName,
379	java.lang.Class<? extends java.lang.annotation.Annotation> annotation)</PRE>
380	<DL>
381	<DD>Scans the application classloader to retrieve all types annotated with a specific annotation.
382	<p>
383	This method is useful for some plug-ins, for example the EBean plugin will automatically detect all types
384	annotated with <code>@javax.persistance.Entity</code>.
385	<p>
386	Note that it is better to specify a very specific package to avoid expensive searches.
387	<P>
388	<DD><DL>
389	<DT><B>Parameters:</B><DD><CODE>packageName</CODE> - the root package to scan<DD><CODE>annotation</CODE> - annotation class
390	<DT><B>Returns:</B><DD>a set of types names statifying the condition</DL>
391	</DD>
392	</DL>
393	<HR>
394
395	<A NAME="isDev()"><!-- --></A><H3>
396	isDev</H3>
397	<PRE>
398	public boolean <B>isDev</B>()</PRE>
399	<DL>
400	<DD>Returns `true` if the application is `DEV` mode.
401	<P>
402	<DD><DL>
403	</DL>
404	</DD>
405	</DL>
406	<HR>
407
408	<A NAME="isProd()"><!-- --></A><H3>
409	isProd</H3>
410	<PRE>
411	public boolean <B>isProd</B>()</PRE>
412	<DL>
413	<DD>Returns `true` if the application is `PROD` mode.
414	<P>
415	<DD><DL>
416	</DL>
417	</DD>
418	</DL>
419	<HR>
420
421	<A NAME="isTest()"><!-- --></A><H3>
422	isTest</H3>
423	<PRE>
424	public boolean <B>isTest</B>()</PRE>
425	<DL>
426	<DD>Returns `true` if the application is `TEST` mode.
427	<P>
428	<DD><DL>
429	</DL>
430	</DD>
431	</DL>
432	<!-- ========= END OF CLASS DATA ========= -->
433	<HR>
434
435
436	<!-- ======= START OF BOTTOM NAVBAR ====== -->
437	<A NAME="navbar_bottom"><!-- --></A>
438	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
439	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
440	<TR>
441	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
442	<A NAME="navbar_bottom_firstrow"><!-- --></A>
443	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
444	<TR ALIGN="center" VALIGN="top">
445	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
446	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
447	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
448	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
449	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
450	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
451	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
452	</TR>
453	</TABLE>
454	</TD>
455	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
456	</EM>
457	</TD>
458	</TR>
459
460	<TR>
461	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
462	PREV CLASS
463	<A HREF="../play/Configuration.html" title="class in play"><B>NEXT CLASS</B></A></FONT></TD>
464	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
465	<A HREF="../index.html?play/Application.html" target="_top"><B>FRAMES</B></A>
466	<A HREF="Application.html" target="_top"><B>NO FRAMES</B></A>
467	<SCRIPT type="text/javascript">
468	<!--
469	if(window==top) {
470	document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
471	}
472	//-->
473	</SCRIPT>
474	<NOSCRIPT>
475	<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
476	</NOSCRIPT>
477
478
479	</FONT></TD>
480	</TR>
481	<TR>
482	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
483	SUMMARY: NESTED \| FIELD \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
484	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
485	DETAIL: FIELD \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
486	</TR>
487	</TABLE>
488	<A NAME="skip-navbar_bottom"></A>
489	<!-- ======== END OF BOTTOM NAVBAR ======= -->
490
491	<HR>
492
493	</BODY>
494	</HTML>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: