01: /*
02: * Copyright (c) 2002-2008 Gargoyle Software Inc. All rights reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, are permitted provided that the following conditions are met:
06: *
07: * 1. Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: * 2. Redistributions in binary form must reproduce the above copyright notice,
10: * this list of conditions and the following disclaimer in the documentation
11: * and/or other materials provided with the distribution.
12: * 3. The end-user documentation included with the redistribution, if any, must
13: * include the following acknowledgment:
14: *
15: * "This product includes software developed by Gargoyle Software Inc.
16: * (http://www.GargoyleSoftware.com/)."
17: *
18: * Alternately, this acknowledgment may appear in the software itself, if
19: * and wherever such third-party acknowledgments normally appear.
20: * 4. The name "Gargoyle Software" must not be used to endorse or promote
21: * products derived from this software without prior written permission.
22: * For written permission, please contact info@GargoyleSoftware.com.
23: * 5. Products derived from this software may not be called "HtmlUnit", nor may
24: * "HtmlUnit" appear in their name, without prior written permission of
25: * Gargoyle Software Inc.
26: *
27: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
28: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
29: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
30: * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
31: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
33: * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
36: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37: */
38: package com.gargoylesoftware.htmlunit;
39:
40: /**
41: * This object contains the result of executing a chunk of script code.
42: *
43: * @version $Revision: 2132 $
44: * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
45: * @author Marc Guillemot
46: */
47: public final class ScriptResult {
48: private final Object javaScriptResult_;
49: private final Page newPage_;
50:
51: /**
52: * Create an instance
53: *
54: * @param javaScriptResult The object that was returned from the script engine
55: * @param newPage The page that is currently loaded at the end of the script
56: * execution.
57: */
58: public ScriptResult(final Object javaScriptResult,
59: final Page newPage) {
60: javaScriptResult_ = javaScriptResult;
61: newPage_ = newPage;
62: }
63:
64: /**
65: * Return the object that was the output of the script engine.
66: * @return The result from the script engine.
67: */
68: public Object getJavaScriptResult() {
69: return javaScriptResult_;
70: }
71:
72: /**
73: * Return the page that is loaded at the end of the script execution.
74: * @return The new page.
75: */
76: public Page getNewPage() {
77: return newPage_;
78: }
79:
80: /**
81: * Utility method testing if a script result is <code>false</code>
82: * @param scriptResult a script result (may be <code>null</code>)
83: * @return <code>true</code> if <code>scriptResult</code> is <code>false</code>
84: */
85: public static boolean isFalse(final ScriptResult scriptResult) {
86: return scriptResult != null
87: && Boolean.FALSE.equals(scriptResult
88: .getJavaScriptResult());
89: }
90: }
|