DomExt (orion-kit 2.0.1 API)

java.lang.Object
- cn.orionsec.kit.lang.utils.ext.dom.DomExt

```
public class DomExt
extends Object
```
XML 提取器

Since:

2020/3/23 14:10

Version:

1.0.0

Author:

Jiahang Li

Constructor Summary

Constructors
Constructor and Description

DomExt(org.dom4j.Document document)

DomExt(File file)

DomExt(InputStream in)

DomExt(String xml)

Constructors
Constructor and Description
`DomExt(org.dom4j.Document document)`
`DomExt(File file)`
`DomExt(InputStream in)`
`DomExt(String xml)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DomExt`	`cleanComment()` 去除注释
`String`	`format()`
`String`	`format(org.dom4j.io.OutputFormat format)` 获取当前 document 的 xml
`org.dom4j.Document`	`getDocument()` 获取 document
`org.dom4j.Element`	`getRootElement()` 获取根 element
`Map<String,List<org.dom4j.Element>>`	`getRootElements()` 获取根节点元素
`static DomExt`	`of(org.dom4j.Document document)`
`static DomExt`	`of(File file)`
`static DomExt`	`of(InputStream in)`
`static DomExt`	`of(String xml)`
`org.dom4j.Element`	`parse(String formula)` 获取解析的element 不需要包含跟元素
`String`	`parseValue(String formula)` 获取解析的element的value 不需要包含跟元素
`DomStream`	`stream()` 获取dom流
`<T> T`	`toBean(Class<T> clazz)`
`<T> T`	`toBean(Class<T> clazz, Map<String,Object> convertMapper)`
`<T> T`	`toBean(String formula, Class<T> clazz)`
`<T> T`	`toBean(String formula, Class<T> clazz, Map<String,Object> convertMapper)` xml 转 bean
`Map<String,DomNode>`	`toDomNode()`
`Map<String,DomNode>`	`toDomNode(String formula)` xml 解析为 domNode 有标签值, 有属性值, 不具有根标签
`Map<String,Object>`	`toMap()`
`Map<String,Object>`	`toMap(Class<?> mapClass)`
`Map<String,Object>`	`toMap(String formula)`
`Map<String,Object>`	`toMap(String formula, Class<?> mapClass)` xml 解析为 map 只有标签值, 没有属性值, 不具有根标签
`String`	`toString()`
`String`	`toXml()` 获取当前 document 的 xml

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

Constructor Detail

DomExt
```
public DomExt(File file)
```

DomExt
```
public DomExt(String xml)
```

DomExt
```
public DomExt(InputStream in)
```

DomExt

public DomExt(org.dom4j.Document document)

Method Detail
- of
```
public static DomExt of(File file)
```
- of
```
public static DomExt of(String xml)
```
- of
```
public static DomExt of(InputStream in)
```
- of
```
public static DomExt of(org.dom4j.Document document)
```
- stream
```
public DomStream stream()
```
  获取dom流
  
  Returns:
  
  dom流
- parse
```
public org.dom4j.Element parse(String formula)
```
  获取解析的element 不需要包含跟元素
  
  Parameters:
  
  formula - 如: bean[1] > property > list > ref[0]:name=c 语法: [n] 下标 k:v 属性
  
  Returns:
  
  element
- parseValue
```
public String parseValue(String formula)
```
  获取解析的element的value 不需要包含跟元素
  
  Parameters:
  
  formula - 如: bean[1] > property > list > ref[0]:name=c 语法: [n] 下标 k:v 属性
  
  Returns:
  
  element的value
- getDocument
```
public org.dom4j.Document getDocument()
```
  获取 document
  
  Returns:
  
  document
- getRootElement
```
public org.dom4j.Element getRootElement()
```
  获取根 element
  
  Returns:
  
  element
- getRootElements
```
public Map<String,List<org.dom4j.Element>> getRootElements()
```
  获取根节点元素
  
  Returns:
  
  element
- toMap
```
public Map<String,Object> toMap()
```
- toMap
```
public Map<String,Object> toMap(Class<?> mapClass)
```
- toMap
```
public Map<String,Object> toMap(String formula)
```
- toMap
```
public Map<String,Object> toMap(String formula,
                                Class<?> mapClass)
```
  xml 解析为 map 只有标签值, 没有属性值, 不具有根标签
  
  Parameters:
  
  formula - 如: bean[1] > property > list > ref[0]:name=c 语法: [n] 下标 k:v 属性
  
  mapClass - mapClass
  
  Returns:
  
  map
- toBean
```
public <T> T toBean(Class<T> clazz)
```
- toBean
```
public <T> T toBean(Class<T> clazz,
                    Map<String,Object> convertMapper)
```
- toBean
```
public <T> T toBean(String formula,
                    Class<T> clazz)
```
- toBean
```
public <T> T toBean(String formula,
                    Class<T> clazz,
                    Map<String,Object> convertMapper)
```
  xml 转 bean
  
  Type Parameters:
  
  T - beanType
  
  Parameters:
  
  formula - 如: bean[1] > property > list > ref[0]:name=c 语法: [n] 下标 k:v 属性
  
  clazz - beanClass
  
  convertMapper - 属性转换map key:xml value:bean
  
  Returns:
  
  bean
- toDomNode
```
public Map<String,DomNode> toDomNode()
```
- toDomNode
```
public Map<String,DomNode> toDomNode(String formula)
```
  xml 解析为 domNode 有标签值, 有属性值, 不具有根标签
  
  Parameters:
  
  formula - 如: bean[1] > property > list > ref[0]:name=c 语法: [n] 下标 k:v 属性
  
  Returns:
  
  DomNode
- cleanComment
```
public DomExt cleanComment()
```
  去除注释
- toXml
```
public String toXml()
```
  获取当前 document 的 xml
  
  Returns:
  
  xml
- format
```
public String format()
```
- format
```
public String format(org.dom4j.io.OutputFormat format)
```
  获取当前 document 的 xml
  
  Parameters:
  
  format - format
  
  Returns:
  
  格式化后的xml
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object

Class DomExt

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DomExt

DomExt

DomExt

DomExt

Method Detail

of

of

of

of

stream

parse

parseValue

getDocument

getRootElement

getRootElements

toMap

toMap

toMap

toMap

toBean

toBean

toBean

toBean

toDomNode

toDomNode

cleanComment

toXml

format

format

toString