com.github.wuic.engine.core

Class TextInspectorEngine

java.lang.Object

com.github.wuic.engine.Engine

com.github.wuic.engine.NodeEngine

com.github.wuic.engine.core.TextInspectorEngine

All Implemented Interfaces:

EngineRequestTransformer.RequireEngineRequestTransformer, NutFilterHolder, Comparable<Engine>

Direct Known Subclasses:

CssInspectorEngine, JavascriptInspectorEngine

public abstract class TextInspectorEngine
extends NodeEngine
implements NutFilterHolder, EngineRequestTransformer.RequireEngineRequestTransformer

Basic inspector engine for text nuts processing text line per line. This kind of engine inspects each nut of a request to eventually alter their content or to extract other referenced nuts thanks to a set of inspectors.

Since:

0.3.3

Version:

1.5

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
TextInspectorEngine(Boolean inspect, String cs, LineInspector... inspectors) Builds a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addInspector(LineInspector inspector) Adds a new inspector.
protected void	inspect(ConvertibleNut nut, EngineRequest request) Extracts from the given nut all the nuts referenced by the @import statement in CSS.
protected String	inspectLine(String line, EngineRequest request, LineInspector inspector, List<LineInspector.ReplacementInfo> replacementInfoList, CompositeNut.CompositeInputStream cis, ConvertibleNut original) Inspects the given line and eventually adds some extracted nuts to the nut referencing it.
List<ConvertibleNut>	internalParse(EngineRequest request) Internal method that parses eventually called by NodeEngine.parse(EngineRequest) method during its invocation.
void	setNutFilter(List<NutFilter> nutFilters) Sets the filter.
void	transform(InputStream is, OutputStream os, ConvertibleNut convertibleNut, EngineRequest request) Matches the Pipe.Transformer.transform(java.io.InputStream, java.io.OutputStream, Object) signature with an additional EngineRequest.
Boolean	works() Returns a flag indicating if the engine is configured to do something or not.

Methods inherited from class com.github.wuic.engine.NodeEngine

callNextEngine, chain, getNext, getNutTypes, getPrevious, parse, setNext

Methods inherited from class com.github.wuic.engine.Engine

compareTo, getEngineType

Methods inherited from class java.lang.Object

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

Constructor Detail

TextInspectorEngine

public TextInspectorEngine(Boolean inspect,
                   String cs,
                   LineInspector... inspectors)

Builds a new instance.

Parameters:

inspect - activate inspection or not

cs - files charset

inspectors - the line inspectors to use

Method Detail

addInspector

public final void addInspector(LineInspector inspector)

Adds a new inspector.

Parameters:

inspector - the new inspector

internalParse

public List<ConvertibleNut> internalParse(EngineRequest request)
                                   throws WuicException

Internal method that parses eventually called by NodeEngine.parse(EngineRequest) method during its invocation.

Specified by:

internalParse in class Engine

Parameters:

request - the request with files to parse

Returns:

the parsed files

Throws:

WuicException - if any kind of error occurs

inspect

protected void inspect(ConvertibleNut nut,
           EngineRequest request)
                throws WuicException

Extracts from the given nut all the nuts referenced by the @import statement in CSS.

Parameters:

nut - the nut

request - the initial request

Throws:

WuicException - if an I/O error occurs while reading

inspectLine

protected String inspectLine(String line,
                 EngineRequest request,
                 LineInspector inspector,
                 List<LineInspector.ReplacementInfo> replacementInfoList,
                 CompositeNut.CompositeInputStream cis,
                 ConvertibleNut original)
                      throws WuicException

Inspects the given line and eventually adds some extracted nuts to the nut referencing it.

This method is recursive.

Parameters:

line - the line to be inspected

request - the initial request

inspector - the inspector to use

replacementInfoList - the collection where any referenced nut identified by the method will be added

cis - a composite stream which indicates what nut owns the transformed text, null if the nut is not a composition

original - the inspected nut

Returns:

the given line eventually transformed

Throws:

WuicException - if an I/O error occurs while reading

works

public Boolean works()

Returns a flag indicating if the engine is configured to do something or not.

Specified by:

works in class Engine

Returns:

true is something will be done, false otherwise

setNutFilter

public void setNutFilter(List<NutFilter> nutFilters)

Sets the filter.

Specified by:

setNutFilter in interface NutFilterHolder

Parameters:

nutFilters - the filters

transform

public void transform(InputStream is,
             OutputStream os,
             ConvertibleNut convertibleNut,
             EngineRequest request)
               throws IOException

Matches the Pipe.Transformer.transform(java.io.InputStream, java.io.OutputStream, Object) signature with an additional EngineRequest.

Specified by:

transform in interface EngineRequestTransformer.RequireEngineRequestTransformer

Parameters:

is - the input

os - the output

convertibleNut - the object that provides the original input stream

request - the EngineRequest

Throws:

IOException - if an I/O error occurs