TemplatePruner

java.lang.Object
- com.dpslink.base.util.TemplatePruner

All Implemented Interfaces:

java.io.Serializable
```
public class TemplatePruner
extends java.lang.Object
implements java.io.Serializable
```
Prunes or extracts various types of elements from a template.
The methods in this class are accessible from within a template via the $prn variable.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private static java.util.Hashtable<java.lang.String,java.util.regex.Pattern>`	`cvRegExPatterns` A cache of compiled regular expression patterns.
`private static long`	`serialVersionUID` The class' serialization version id.

Constructor Summary

Constructors
Constructor and Description

TemplatePruner()

Constructors
Constructor and Description
`TemplatePruner()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`cleanHtml(java.lang.String s)` Returns a cleaned copy of a given string of HTML.
`static java.lang.StringBuilder`	`getHtmlBody(java.lang.StringBuilder sb)` Extracts the HTML body from a string.
`static java.util.ArrayList<java.lang.String>`	`getHtmlScripts(java.lang.StringBuilder sb)` Extracts the HTML script definitions from a string.
`static java.util.ArrayList<java.lang.String>`	`getHtmlStyles(java.lang.StringBuilder sb)` Extracts the HTML style sheet definitions from a string.
`static java.lang.String`	`getHtmlTitle(java.lang.StringBuilder sb)` Extracts the HTML title from a string.
`static java.lang.String`	`removeWhitespace(java.lang.String s)` Removes all whitespace from a string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    The class' serialization version id.
    
    See Also:
    
    Constant Field Values
  - cvRegExPatterns
```
private static java.util.Hashtable<java.lang.String,java.util.regex.Pattern> cvRegExPatterns
```
    A cache of compiled regular expression patterns.
- Constructor Detail
  - TemplatePruner
```
public TemplatePruner()
```
- Method Detail
  - cleanHtml
```
public static java.lang.String cleanHtml(java.lang.String s)
```
    Returns a cleaned copy of a given string of HTML. Intended for use with the Velocity #parse macro whereby the string to be processed is a parsed template that is about to be merged with another template. The template being merged could contain code that would result in invalid HTML after the merge. A cleaned copy has all potentially damaging code removed (i.e. extra <head> tags, extra <body> tags, etc.).
    
    Parameters:
    
    s - (String) The string to process.
    
    Returns:
    
    String - The processed results.
  - getHtmlBody
```
public static java.lang.StringBuilder getHtmlBody(java.lang.StringBuilder sb)
```
    Extracts the HTML body from a string. Discards anything not located between the <body> and </body> tags. The <body> and </body> tags are also discarded.
    
    Parameters:
    
    sb - (StringBuilder) The string to process.
    
    Returns:
    
    StringBuilder - The processed results.
  - getHtmlScripts
```
public static java.util.ArrayList<java.lang.String> getHtmlScripts(java.lang.StringBuilder sb)
```
    Extracts the HTML script definitions from a string. Script definitions are enclosed within <script... and </script tags. The tags are included in the results. Each element of the results represents a single script definition, which may be a link to a script file or may be the actual script code.
    
    Parameters:
    
    sb - (StringBuilder) The string to process.
    
    Returns:
    
    ArrayList - The processed results.
  - getHtmlStyles
```
public static java.util.ArrayList<java.lang.String> getHtmlStyles(java.lang.StringBuilder sb)
```
    Extracts the HTML style sheet definitions from a string. Style sheet definitions are assumed to begin with a <link tag and end with .css">. Each element of the results represents a single style sheet definition.
    
    Parameters:
    
    sb - (StringBuilder) The string to process.
    
    Returns:
    
    ArrayList - The processed results.
  - getHtmlTitle
```
public static java.lang.String getHtmlTitle(java.lang.StringBuilder sb)
```
    Extracts the HTML title from a string. Discards anything not located between the <title> and </title> tags. The <title> and </title> tags are also discarded.
    
    Parameters:
    
    sb - (StringBuilder) The string to process.
    
    Returns:
    
    String - The processed results.
  - removeWhitespace
```
public static java.lang.String removeWhitespace(java.lang.String s)
                                         throws java.lang.Exception
```
    Removes all whitespace from a string. Whitespace is removed per the following:
    - Individual lines are trimmed (i.e. String.trim()).
    - Empty (blank) lines are removed.
    - Empty html comment blocks are removed. Comment blocks are assumed to begin with .
    Parameters:
    
    s - (String) The string to process.
    
    Returns:
    
    String - The processed results.
    
    Throws:
    
    java.lang.Exception - - if an error occurs during processing.

Class TemplatePruner

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

cvRegExPatterns

Constructor Detail

TemplatePruner

Method Detail

cleanHtml

getHtmlBody

getHtmlScripts

getHtmlStyles

getHtmlTitle

removeWhitespace