com.github.wuic.engine

Class LineInspector

java.lang.Object

com.github.wuic.engine.LineInspector

Direct Known Subclasses:

AngularTemplateInspector, CssUrlLineInspector, SourceMapLineInspector

public abstract class LineInspector
extends Object

Represents an object providing replacement functionality inside a line for a group of character matching a particular pattern.

Since:

0.3.3

Version:

1.3

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LineInspector.ReplacementInfo This object indicates the index of the rewritten statement and the associated list of nuts.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	STRING_LITERAL_REGEX Possible value for path name.

Constructor Summary

Constructors

Constructor and Description
LineInspector(Pattern p) Builds a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
abstract List<? extends ConvertibleNut>	appendTransformation(Matcher matcher, StringBuilder replacement, EngineRequest request, CompositeNut.CompositeInputStream cis, ConvertibleNut originalNut) Computes the replacement to be made inside the text for the given Matcher which its find() method as just been called.
static void	fallbackToVersionNumberInQueryString(StringBuilder sb, String referencedPath, Nut originalNut) When the nut resolution fails (no nut found), the path is keep in the source file.
static NutsHeap	getHeap(EngineRequest request, ConvertibleNut originalNut, CompositeNut.CompositeInputStream cis, Matcher matcher, int groupIndex) Gets the NutsHeap pointing to the right NutDao according to the given original nut.
Pattern	getPattern() Gets the pattern to find text to be replaced inside the lines.
static List<? extends ConvertibleNut>	manageAppend(ConvertibleNut nut, StringBuilder replacement, EngineRequest request, NutsHeap heap, EngineType... skippedEngine) Manages the given nut that corresponds to the specified referenced path and append the transformation with proper path.
LineInspector.ReplacementInfo	replacementInfo(int startIndex, int endIndex, Nut referencer, List<? extends ConvertibleNut> convertibleNuts) Builds a new LineInspector.ReplacementInfo.
protected abstract String	toString(ConvertibleNut convertibleNut) Converts the given ConvertibleNut to a String representation that is possible to append directly to the referencer.

Methods inherited from class java.lang.Object

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

Field Detail

STRING_LITERAL_REGEX

protected static final String STRING_LITERAL_REGEX

Possible value for path name.

See Also:

Constant Field Values

Constructor Detail

LineInspector

public LineInspector(Pattern p)

Builds a new instance.

Parameters:

p - the pattern.

Method Detail

fallbackToVersionNumberInQueryString

public static void fallbackToVersionNumberInQueryString(StringBuilder sb,
                                        String referencedPath,
                                        Nut originalNut)
                                                 throws WuicException

When the nut resolution fails (no nut found), the path is keep in the source file. However, this method allows to append this path to a StringBuilder with a version number retrieved from the referencer in order to give a chance to evict client cache.

Parameters:

sb - the string builder to append

referencedPath - the unresolved path

originalNut - the referencer with the version number

Throws:

WuicException - if version number resolution fails

manageAppend

public static List<? extends ConvertibleNut> manageAppend(ConvertibleNut nut,
                                          StringBuilder replacement,
                                          EngineRequest request,
                                          NutsHeap heap,
                                          EngineType... skippedEngine)
                                                   throws WuicException

Manages the given nut that corresponds to the specified referenced path and append the transformation with proper path.

Parameters:

nut - the nut retrieved with path

replacement - the string builder to append

request - the engine request

heap - the heap that contains the original nut

skippedEngine - the engine to skip when processing resulting nuts

Returns:

the processed nuts specified in parameter

Throws:

WuicException - if processing fails

getHeap

public static NutsHeap getHeap(EngineRequest request,
               ConvertibleNut originalNut,
               CompositeNut.CompositeInputStream cis,
               Matcher matcher,
               int groupIndex)

Gets the NutsHeap pointing to the right NutDao according to the given original nut.

Parameters:

request - the request

originalNut - the original nut

cis - the composite stream if any

matcher - the matcher that inspects the stream

groupIndex - the group index of currently matched value

Returns:

the heap

getPattern

public final Pattern getPattern()

Gets the pattern to find text to be replaced inside the lines.

Returns:

the pattern to use

replacementInfo

public LineInspector.ReplacementInfo replacementInfo(int startIndex,
                                            int endIndex,
                                            Nut referencer,
                                            List<? extends ConvertibleNut> convertibleNuts)

Builds a new LineInspector.ReplacementInfo.

Parameters:

startIndex - the start index

endIndex - the end index

referencer - the referencer

convertibleNuts - the nuts

Returns:

the new instance

appendTransformation

public abstract List<? extends ConvertibleNut> appendTransformation(Matcher matcher,
                                                  StringBuilder replacement,
                                                  EngineRequest request,
                                                  CompositeNut.CompositeInputStream cis,
                                                  ConvertibleNut originalNut)
                                                             throws WuicException

Computes the replacement to be made inside the text for the given Matcher which its find() method as just been called.

Parameters:

matcher - the matcher which provides found text thanks to its group() method.

replacement - the text which will replace the matching text

request - the request that orders this transformation

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

originalNut - the original nut

Returns:

the nut that was referenced in the matching text, null if the inspector did not perform any change

Throws:

WuicException - if an exception occurs

toString

protected abstract String toString(ConvertibleNut convertibleNut)
                            throws IOException

Converts the given ConvertibleNut to a String representation that is possible to append directly to the referencer. This could be used as an alternative to URL statements.

Parameters:

convertibleNut - the convertible nut to convert

Returns:

the String representation, null if no inclusion is possible

Throws:

IOException - if the transformation fails