com.github.wuic.engine

Class EngineRequest

java.lang.Object

com.github.wuic.engine.EngineRequest

public final class EngineRequest
extends Object

This class represents a request to be indicated to an engine.

The user which invokes NodeEngine.parse(EngineRequest) should indicates in the parameter the nuts to be parsed and the context path to use to expose the generated nuts.

Since:

0.3.0

Version:

1.6

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EngineRequest.Key This class overrides Object.equals(Object) and Object.hashCode() to represent an unique key per EngineRequest based on its workflow ID and its nuts.

Method Summary

Methods

Modifier and Type	Method and Description
EngineType[]	alsoSkip(EngineType... type) Returns an array containing all items of EngineRequestBuilder.skip and also the specified types.
NodeEngine	getChainFor(NutType nutType) Gets the chains which can treat nuts of the given NutType.
String	getContextPath() Gets the context path.
NutsHeap	getHeap() Returns the heap.
NutsHeap	getHeap(String workflowId) Gets the heap associated to the given workflow.
EngineRequest.Key	getKey() Creates a new key that identifies this request if null and return it.
List<ConvertibleNut>	getNuts() Gets the nuts.
String	getPrefixCreatedNut() Returns the prefix created nut
ProcessContext	getProcessContext() Gets the ProcessContext.
UrlProviderFactory	getUrlProviderFactory() Gets the UrlProviderFactory.
String	getWorkflowId() Gets the workflow ID.
boolean	isBestEffort() Indicates if this request requires best effort mode.
boolean	isExcludedFromSpriteComputation(Nut nut) Indicates if the given nut should be excluded from any sprite computation.
boolean	isStaticsServedByWuicServlet() Indicates if result is served by WUIC servlet.
Iterator<List<? extends ConvertibleNut>>	iterator() Creates a new iterator on the nuts.
boolean	shouldSkip(EngineType engineType) Indicates if an engine of the given type should skip its treatment when this request is submitted.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getPrefixCreatedNut

public String getPrefixCreatedNut()

Returns the prefix created nut

Returns:

the created nut

getNuts

public List<ConvertibleNut> getNuts()

Gets the nuts.

Returns:

the nuts

getContextPath

public String getContextPath()

Gets the context path.

Returns:

the context path

getHeap

public NutsHeap getHeap()

Returns the heap.

Returns:

the heap

getWorkflowId

public String getWorkflowId()

Gets the workflow ID.

Returns:

the workflow ID.

iterator

public Iterator<List<? extends ConvertibleNut>> iterator()

Creates a new iterator on the nuts.

Returns:

the iterator

getChainFor

public NodeEngine getChainFor(NutType nutType)

Gets the chains which can treat nuts of the given NutType.

Parameters:

nutType - the nut type

Returns:

the chains that can treat this nut type

shouldSkip

public boolean shouldSkip(EngineType engineType)

Indicates if an engine of the given type should skip its treatment when this request is submitted.

Parameters:

engineType - the EngineType

Returns:

true if treatment should be skipped, false otherwise.

isBestEffort

public boolean isBestEffort()

Indicates if this request requires best effort mode.

Returns:

true if the request requires best effort, false otherwise

isStaticsServedByWuicServlet

public boolean isStaticsServedByWuicServlet()

Indicates if result is served by WUIC servlet.

Returns:

true if statics are served by WUIC servlet, false otherwise

getKey

public EngineRequest.Key getKey()

Creates a new key that identifies this request if null and return it.

Returns:

the key

getUrlProviderFactory

public UrlProviderFactory getUrlProviderFactory()

Gets the UrlProviderFactory.

Returns:

the factory

getProcessContext

public ProcessContext getProcessContext()

Gets the ProcessContext.

Returns:

the process context

alsoSkip

public EngineType[] alsoSkip(EngineType... type)

Returns an array containing all items of EngineRequestBuilder.skip and also the specified types.

Parameters:

type - the array to add

Returns:

the skipped engines including the parameter

getHeap

public NutsHeap getHeap(String workflowId)
                 throws WorkflowNotFoundException

Gets the heap associated to the given workflow.

Parameters:

workflowId - the workflow ID

Returns:

the associated heap

Throws:

WorkflowNotFoundException - if workflow has not been found

isExcludedFromSpriteComputation

public boolean isExcludedFromSpriteComputation(Nut nut)

Indicates if the given nut should be excluded from any sprite computation.

Parameters:

nut - the nut to exclude or not

Returns:

true if nut is excluded, false otherwise

toString

public String toString()

Overrides:

toString in class Object