source: Dev/branches/play-2.0.1/documentation/api/java/play/Play.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: 10.6 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>
7Play (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">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="Play (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>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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&nbsp;<A HREF="../play/Logger.ALogger.html" title="class in play"><B>PREV CLASS</B></A>&nbsp;
58&nbsp;<A HREF="../play/Plugin.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/Play.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61&nbsp;<A HREF="Play.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
62&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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">
90play</FONT>
91<BR>
92Class Play</H2>
93<PRE>
94java.lang.Object
95  <IMG SRC="../resources/inherit.gif" ALT="extended by "><B>play.Play</B>
96</PRE>
97<HR>
98<DL>
99<DT><PRE>public class <B>Play</B><DT>extends java.lang.Object</DL>
100</PRE>
101
102<P>
103High-level API to access Play global features.
104<P>
105
106<P>
107<HR>
108
109<P>
110
111<!-- ======== CONSTRUCTOR SUMMARY ======== -->
112
113<A NAME="constructor_summary"><!-- --></A>
114<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
115<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
116<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
117<B>Constructor Summary</B></FONT></TH>
118</TR>
119<TR BGCOLOR="white" CLASS="TableRowColor">
120<TD><CODE><B><A HREF="../play/Play.html#Play()">Play</A></B>()</CODE>
121
122<BR>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
124</TR>
125</TABLE>
126&nbsp;
127<!-- ========== METHOD SUMMARY =========== -->
128
129<A NAME="method_summary"><!-- --></A>
130<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
131<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
132<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
133<B>Method Summary</B></FONT></TH>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<CODE>static&nbsp;<A HREF="../play/Application.html" title="class in play">Application</A></CODE></FONT></TD>
138<TD><CODE><B><A HREF="../play/Play.html#application()">application</A></B>()</CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the currently running application.</TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145<CODE>static&nbsp;boolean</CODE></FONT></TD>
146<TD><CODE><B><A HREF="../play/Play.html#isDev()">isDev</A></B>()</CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns `true` if the current application is `DEV` mode.</TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153<CODE>static&nbsp;boolean</CODE></FONT></TD>
154<TD><CODE><B><A HREF="../play/Play.html#isProd()">isProd</A></B>()</CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns `true` if the current application is `PROD` mode.</TD>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE>static&nbsp;boolean</CODE></FONT></TD>
162<TD><CODE><B><A HREF="../play/Play.html#isTest()">isTest</A></B>()</CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns `true` if the current application is `TEST` mode.</TD>
166</TR>
167</TABLE>
168&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
169<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
170<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
171<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
175</TR>
176</TABLE>
177&nbsp;
178<P>
179
180<!-- ========= CONSTRUCTOR DETAIL ======== -->
181
182<A NAME="constructor_detail"><!-- --></A>
183<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
184<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
185<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
186<B>Constructor Detail</B></FONT></TH>
187</TR>
188</TABLE>
189
190<A NAME="Play()"><!-- --></A><H3>
191Play</H3>
192<PRE>
193public <B>Play</B>()</PRE>
194<DL>
195</DL>
196
197<!-- ============ METHOD DETAIL ========== -->
198
199<A NAME="method_detail"><!-- --></A>
200<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
201<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
202<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
203<B>Method Detail</B></FONT></TH>
204</TR>
205</TABLE>
206
207<A NAME="application()"><!-- --></A><H3>
208application</H3>
209<PRE>
210public static <A HREF="../play/Application.html" title="class in play">Application</A> <B>application</B>()</PRE>
211<DL>
212<DD>Returns the currently running application.
213<P>
214<DD><DL>
215</DL>
216</DD>
217</DL>
218<HR>
219
220<A NAME="isDev()"><!-- --></A><H3>
221isDev</H3>
222<PRE>
223public static boolean <B>isDev</B>()</PRE>
224<DL>
225<DD>Returns `true` if the current application is `DEV` mode.
226<P>
227<DD><DL>
228</DL>
229</DD>
230</DL>
231<HR>
232
233<A NAME="isProd()"><!-- --></A><H3>
234isProd</H3>
235<PRE>
236public static boolean <B>isProd</B>()</PRE>
237<DL>
238<DD>Returns `true` if the current application is `PROD` mode.
239<P>
240<DD><DL>
241</DL>
242</DD>
243</DL>
244<HR>
245
246<A NAME="isTest()"><!-- --></A><H3>
247isTest</H3>
248<PRE>
249public static boolean <B>isTest</B>()</PRE>
250<DL>
251<DD>Returns `true` if the current application is `TEST` mode.
252<P>
253<DD><DL>
254</DL>
255</DD>
256</DL>
257<!-- ========= END OF CLASS DATA ========= -->
258<HR>
259
260
261<!-- ======= START OF BOTTOM NAVBAR ====== -->
262<A NAME="navbar_bottom"><!-- --></A>
263<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
264<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
265<TR>
266<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
267<A NAME="navbar_bottom_firstrow"><!-- --></A>
268<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
269  <TR ALIGN="center" VALIGN="top">
270  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
271  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
272  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
273  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
274  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
275  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
276  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
277  </TR>
278</TABLE>
279</TD>
280<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
281</EM>
282</TD>
283</TR>
284
285<TR>
286<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
287&nbsp;<A HREF="../play/Logger.ALogger.html" title="class in play"><B>PREV CLASS</B></A>&nbsp;
288&nbsp;<A HREF="../play/Plugin.html" title="class in play"><B>NEXT CLASS</B></A></FONT></TD>
289<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
290  <A HREF="../index.html?play/Play.html" target="_top"><B>FRAMES</B></A>  &nbsp;
291&nbsp;<A HREF="Play.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
292&nbsp;<SCRIPT type="text/javascript">
293  <!--
294  if(window==top) {
295    document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
296  }
297  //-->
298</SCRIPT>
299<NOSCRIPT>
300  <A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
301</NOSCRIPT>
302
303
304</FONT></TD>
305</TR>
306<TR>
307<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
308  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
309<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
310DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
311</TR>
312</TABLE>
313<A NAME="skip-navbar_bottom"></A>
314<!-- ======== END OF BOTTOM NAVBAR ======= -->
315
316<HR>
317
318</BODY>
319</HTML>
Note: See TracBrowser for help on using the repository browser.