org.javalite.activeweb

Class SpecHelper

java.lang.Object

org.javalite.test.jspec.JSpecSupport

org.javalite.activeweb.SpecHelper

Direct Known Subclasses:

RequestSpecHelper, ViewSpec

public class SpecHelper
extends org.javalite.test.jspec.JSpecSupport

This class is not used directly in applications.

Author:

Igor Polevoy

Constructor Summary

Constructors

Constructor and Description
SpecHelper()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterEnd()
void	atStart()
protected Object	flash(String name) Returns a named flash value assigned to session by controller.
protected <T> T	flash(String name, Class<T> type) Returns a named flash value assigned to session by controller.
protected void	registerTag(String name, FreeMarkerTag tag) Registers a single custom tag.
protected SessionTestFacade	session() Allows access to session in test context.
protected <T> T	session(String name, Class<T> type) Returns object from session that is already cast to expected type.
protected void	session(String name, Serializable value) Convenience method, sets an object on a session.
protected Boolean	sessionBoolean(String name) Convenience method, returns object from session, equivalent of:
protected Double	sessionDouble(String name) Convenience method, returns object from session, equivalent of:
protected Float	sessionFloat(String name) Convenience method, returns object from session, equivalent of:
protected boolean	sessionHas(String name) Returns true if session has named object, false if not.
protected Integer	sessionInteger(String name) Convenience method, returns object from session, equivalent of:
protected Long	sessionLong(String name) Convenience method, returns object from session, equivalent of:
protected Object	sessionObject(String name) Convenience method, returns object from session, equivalent of:
protected String	sessionString(String name) Convenience method, returns object from session, equivalent of:
protected void	setInjector(com.google.inject.Injector injector) Use to set injector for current test.
protected void	setTemplateLocation(String location)

Methods inherited from class org.javalite.test.jspec.JSpecSupport

a, expect, expect, it, the

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpecHelper

public SpecHelper()

Method Detail

atStart

public void atStart()

afterEnd

public void afterEnd()

setTemplateLocation

protected void setTemplateLocation(String location)

Parameters:

location - this is a relative location starting from the module root, intended for testing.

setInjector

protected void setInjector(com.google.inject.Injector injector)

Use to set injector for current test.

Parameters:

injector - injector to source dependencies form.

registerTag

protected void registerTag(String name,
               FreeMarkerTag tag)

Registers a single custom tag. You can call this method as many times as necessary to register multiple tags in tests. If you want to use all tags that you registered in app.config.AppBootstrap class, then you an option of using AppIntegrationSpec as a super class.

Parameters:

name - tag name where name is a part of the tag on page like so: <@name....

tag - instance of tag to register.

session

protected SessionTestFacade session()

Allows access to session in test context.

Returns:

object allowing access to session in test context.

flash

protected Object flash(String name)

Returns a named flash value assigned to session by controller.

Parameters:

name - name of flash value.

Returns:

flash value assigned to session by controller.

flash

protected <T> T flash(String name,
          Class<T> type)

Returns a named flash value assigned to session by controller.

Parameters:

name - name of flash value.

type - type to be returned

Returns:

flash value assigned to session by controller.

session

protected void session(String name,
           Serializable value)

Convenience method, sets an object on a session. Equivalent of:

 
     session().put(name, value)
 
 

Parameters:

name - name of object

value - object itself.

sessionObject

protected Object sessionObject(String name)

Convenience method, returns object from session, equivalent of:

 
     session().get(name)
 
 

Parameters:

name - name of object,

Returns:

session object.

sessionString

protected String sessionString(String name)

Convenience method, returns object from session, equivalent of:

 
     String val = (String)session().get(name)
 
 

Parameters:

name - name of object

Returns:

value

sessionInteger

protected Integer sessionInteger(String name)

Convenience method, returns object from session, equivalent of:

 
     Integer val = (Integer)session().get(name)
 
 

Parameters:

name - name of object

Returns:

value

session

protected <T> T session(String name,
            Class<T> type)

Returns object from session that is already cast to expected type.

Parameters:

name - name of object in session

type - expected type.

Returns:

object from session that is already cast to expected type.

sessionBoolean

protected Boolean sessionBoolean(String name)

Convenience method, returns object from session, equivalent of:

 
     Boolean val = (Boolean)session().get(name)
 
 

Parameters:

name - name of object

Returns:

value

sessionDouble

protected Double sessionDouble(String name)

Convenience method, returns object from session, equivalent of:

 
     Double val = (Double)session().get(name)
 
 

Parameters:

name - name of object

Returns:

value

sessionFloat

protected Float sessionFloat(String name)

Convenience method, returns object from session, equivalent of:

 
     Float val = (Float)session().get(name)
 
 

Parameters:

name - name of object

Returns:

value

sessionLong

protected Long sessionLong(String name)

Convenience method, returns object from session, equivalent of:

 
     Long val = (Long)session().get(name)
 
 

Parameters:

name - name of object

Returns:

value

sessionHas

protected boolean sessionHas(String name)

Returns true if session has named object, false if not.

Parameters:

name - name of object.

Returns:

true if session has named object, false if not.