Mixer2Engine (Mixer2 1.4-SNAPSHOT API)

java.lang.Object
- org.mixer2.Mixer2Engine

```
public class Mixer2Engine
extends Object
```
mixer2 engine. The instance of this class should be a singleton because of high cost to initialize.

Author:

nabedge

Constructor Summary

Constructors
Constructor and Description

Mixer2Engine()

Constructors
Constructor and Description
`Mixer2Engine()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Html`	`checkAndLoadHtmlTemplate(File file)` This is the same as `loadHtmlTemplate(File)` but if fail to parse xhtml, throws Mixer2JAXBException.
`Html`	`checkAndLoadHtmlTemplate(InputStream inputStream)` This is the same as `loadHtmlTemplate(InputStream)` but if fail to parse xhtml, throws Mixer2JAXBException.
`Html`	`checkAndLoadHtmlTemplate(String str)`
`Html`	`checkAndLoadHtmlTemplate(StringBuffer sb)`
`Html`	`checkAndLoadHtmlTemplate(StringBuilder sb)`
`protected StringBuilder`	`fileToStringBuilder(File file)`
`void`	`init()` initialize method.
`protected StringBuilder`	`inputStreamToStringBuilder(InputStream inputStream)`
`Html`	`loadHtmlTemplate(File file)` load (unmarshal) a xhtml template to Html type object.
`Html`	`loadHtmlTemplate(InputStream inputStream)` load html template from input stream.
`Html`	`loadHtmlTemplate(String str)`
`Html`	`loadHtmlTemplate(StringBuffer sb)`
`Html`	`loadHtmlTemplate(StringBuilder sb)`
`StringBuilder`	`removeDoctypeDeclaration(StringBuilder sb)` remove doctype declaration
`protected StringBuilder`	`replaceIframeEndTag(StringBuilder sb)`
`StringBuilder`	`replaceNamedEntity(StringBuilder sb)` replace the reference of character entity reference to numeric character reference.
`String`	`saveToString(List<Object> list)` marshal the inner objects of tag to string and return it.
`<T extends AbstractJaxb> String`	`saveToString(T tag)` marshal tag object to string and return it.
`<T extends AbstractJaxb> void`	`saveToStringWriter(T tag, StringWriter writer)` marshal tag object and write to StringWriter.
`protected Html`	`unmarshal(StringBuilder sb)` unmarshal from html string to html object.

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

- Constructor Detail
  - Mixer2Engine
```
public Mixer2Engine()
```
- Method Detail
  - init
```
public void init()
```
    initialize method. This is called automatically by constructor method.
  - loadHtmlTemplate
```
public Html loadHtmlTemplate(File file)
                      throws IOException
```
    load (unmarshal) a xhtml template to Html type object. Doctype declaration on template will be deleted.
    
    If error to parse xhtml string, returns null.
    
    Parameters:
    
    file -
    
    Returns:
    
    html tag object. If parse error, returns null.
    
    Throws:
    
    IOException
  - checkAndLoadHtmlTemplate
```
public Html checkAndLoadHtmlTemplate(File file)
                              throws IOException,
                                     Mixer2JAXBException
```
    This is the same as loadHtmlTemplate(File) but if fail to parse xhtml, throws Mixer2JAXBException.
    
    Parameters:
    
    file -
    
    Returns:
    
    Throws:
    
    IOException
    
    Mixer2JAXBException - if xhtml parse error.
    
    See Also:
    
    loadHtmlTemplate(File)
  - loadHtmlTemplate
```
public Html loadHtmlTemplate(String str)
```
    Parameters:
    
    str -
    
    Returns:
    
    html tag object. If parse error, returns null.
    
    See Also:
    
    loadHtmlTemplate(File)
  - checkAndLoadHtmlTemplate
```
public Html checkAndLoadHtmlTemplate(String str)
                              throws Mixer2JAXBException
```
    Parameters:
    
    str -
    
    Returns:
    
    Throws:
    
    Mixer2JAXBException
    
    See Also:
    
    checkAndLoadHtmlTemplate(File)
  - loadHtmlTemplate
```
public Html loadHtmlTemplate(StringBuffer sb)
```
    Parameters:
    
    sb -
    
    Returns:
    
    html tag object. If parse error, returns null.
    
    See Also:
    
    loadHtmlTemplate(File)
  - checkAndLoadHtmlTemplate
```
public Html checkAndLoadHtmlTemplate(StringBuffer sb)
                              throws Mixer2JAXBException
```
    Throws:
    
    Mixer2JAXBException
  - loadHtmlTemplate
```
public Html loadHtmlTemplate(StringBuilder sb)
```
    Parameters:
    
    sb - xhtml template string.
    
    Returns:
    
    html tag object. If parse error, returns null.
    
    See Also:
    
    loadHtmlTemplate(File)
  - checkAndLoadHtmlTemplate
```
public Html checkAndLoadHtmlTemplate(StringBuilder sb)
                              throws Mixer2JAXBException
```
    Parameters:
    
    sb - xhtml template string.
    
    Returns:
    
    Throws:
    
    Mixer2JAXBException
    
    See Also:
    
    checkAndLoadHtmlTemplate(File)
  - loadHtmlTemplate
```
public Html loadHtmlTemplate(InputStream inputStream)
                      throws IOException
```
    load html template from input stream. inputStream will be closed at the end of this method. Doctype declaration on template will be deleted. If failed to parse error, returns null.
    
    Parameters:
    
    inputStream -
    
    Returns:
    
    html tag object. If parse error, returns null.
    
    Throws:
    
    IOException - if inputStream is null.
  - checkAndLoadHtmlTemplate
```
public Html checkAndLoadHtmlTemplate(InputStream inputStream)
                              throws IOException,
                                     Mixer2JAXBException
```
    This is the same as loadHtmlTemplate(InputStream) but if fail to parse xhtml, throws Mixer2JAXBException.
    
    Parameters:
    
    inputStream -
    
    Returns:
    
    html tag object.
    
    Throws:
    
    IOException
    
    Mixer2JAXBException
    
    See Also:
    
    loadHtmlTemplate(InputStream)
  - saveToString
```
public <T extends AbstractJaxb> String saveToString(T tag)
```
    marshal tag object to string and return it.
  - saveToStringWriter
```
public <T extends AbstractJaxb> void saveToStringWriter(T tag,
                                                        StringWriter writer)
```
    marshal tag object and write to StringWriter.
  - saveToString
```
public String saveToString(List<Object> list)
```
    marshal the inner objects of tag to string and return it.
```
     <-- html -->
     <div id="foo">aaa<span>bbb</span>ccc</div>
 
```
```
     // code
     List<Object> list = html.getById("foo", Div.class).getContent();
     String contents = mixer2Engine.saveToString(list);
     // "contents" has "aaa<span>bbb</span>ccc"
 
```
    Parameters:
    
    list -
    
    Returns:
  - removeDoctypeDeclaration
```
public StringBuilder removeDoctypeDeclaration(StringBuilder sb)
```
    remove doctype declaration
  - replaceNamedEntity
```
public StringBuilder replaceNamedEntity(StringBuilder sb)
```
    replace the reference of character entity reference to numeric character reference.
    
    Parameters:
    
    sb - xhtml template
    
    Returns:
    
    replaced xhtml template
  - fileToStringBuilder
```
protected StringBuilder fileToStringBuilder(File file)
                                     throws IOException
```
    Throws:
    
    IOException
  - inputStreamToStringBuilder
```
protected StringBuilder inputStreamToStringBuilder(InputStream inputStream)
                                            throws IOException
```
    Throws:
    
    IOException
  - replaceIframeEndTag
```
protected StringBuilder replaceIframeEndTag(StringBuilder sb)
```
  - unmarshal
```
protected Html unmarshal(StringBuilder sb)
                  throws JAXBException
```
    unmarshal from html string to html object.
    
    Parameters:
    
    sb -
    
    Returns:
    
    Throws:
    
    JAXBException

Class Mixer2Engine

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Mixer2Engine

Method Detail

init

loadHtmlTemplate

checkAndLoadHtmlTemplate

loadHtmlTemplate

checkAndLoadHtmlTemplate

loadHtmlTemplate

checkAndLoadHtmlTemplate

loadHtmlTemplate

checkAndLoadHtmlTemplate

loadHtmlTemplate

checkAndLoadHtmlTemplate

saveToString

saveToStringWriter

saveToString

removeDoctypeDeclaration

replaceNamedEntity

fileToStringBuilder

inputStreamToStringBuilder

replaceIframeEndTag

unmarshal