cn.orionsec.kit.lang.utils.ext.dom

Class DomSupport

java.lang.Object

cn.orionsec.kit.lang.utils.ext.dom.DomSupport

public class DomSupport
extends Object

XML 工具类

Since:

2021/8/2 12:34

Version:

1.0.0

Author:

Jiahang Li

Method Summary

Modifier and Type	Method and Description
static String	asXml(org.dom4j.Document document)
static String	asXml(org.dom4j.Element element) 转 xml
static void	cleanComment(org.dom4j.Document document) 去除注释
static void	cleanComment(org.dom4j.Element element) 去除注释
static String	escape(String s) xml 转义
static String	format(org.dom4j.Document document) 格式化 xml 默认格式
static String	format(org.dom4j.Document document, org.dom4j.io.OutputFormat format) 格式化 xml
static String	format(String xml)
static String	format(String xml, org.dom4j.io.OutputFormat format)
static String	formatExpandTag(org.dom4j.Document document) 格式化 xml 禁止空标签自结束
static String	formatExpandTag(String xml)
static String	formatIndent(String xml)
static String	formatIndent(String xml, boolean newLine)
static String	formatIndent(String xml, String indent)
static String	formatIndent(String xml, String indent, boolean newLine) 格式化 xml 缩进
static String	getAttribute(org.dom4j.Element e, String key) 获取属性
static Map<String,String>	getAttributes(org.dom4j.Element e) 获取属性集
static Map<String,List<org.dom4j.Element>>	getElements(org.dom4j.Element element) 获取节点元素
static boolean	isEscape(String s) 是否需要 xml 转义
static org.dom4j.Element	parse(org.dom4j.Element element, String formula) 获取解析的element
static String	parseValue(org.dom4j.Element element, String formula) 获取解析的element的value
static <T> T	toBean(org.dom4j.Document document, Class<T> clazz)
static <T> T	toBean(org.dom4j.Document document, Class<T> clazz, Map<String,Object> convertMapper)
static <T> T	toBean(org.dom4j.Document document, String formula, Class<T> clazz)
static <T> T	toBean(org.dom4j.Document document, String formula, Class<T> clazz, Map<String,Object> convertMapper)
static <T> T	toBean(org.dom4j.Element element, Class<T> clazz)
static <T> T	toBean(org.dom4j.Element element, Class<T> clazz, Map<String,Object> convertMapper)
static <T> T	toBean(org.dom4j.Element element, String formula, Class<T> clazz)
static <T> T	toBean(org.dom4j.Element element, String formula, Class<T> clazz, Map<String,Object> convertMapper) xml 转 bean
static <T> T	toBean(String xml, Class<T> clazz)
static <T> T	toBean(String xml, Class<T> clazz, Map<String,Object> convertMapper)
static <T> T	toBean(String xml, String formula, Class<T> clazz)
static <T> T	toBean(String xml, String formula, Class<T> clazz, Map<String,Object> convertMapper)
static org.dom4j.Document	toDocument(String xml) xml 转 document
static org.dom4j.Document	toDocument(String rootName, Map<String,?> childMap)
static org.dom4j.Document	toDocument(String rootName, Map<String,?> childMap, boolean cdata) 将 map 转为 document
static Map<String,DomNode>	toDomNode(org.dom4j.Document document)
static Map<String,DomNode>	toDomNode(org.dom4j.Document document, String formula)
static Map<String,DomNode>	toDomNode(org.dom4j.Element element)
static Map<String,DomNode>	toDomNode(org.dom4j.Element element, String formula) xml 解析为 domNode 有标签值 有属性值 不具有根标签
static Map<String,DomNode>	toDomNode(String xml)
static Map<String,DomNode>	toDomNode(String xml, String formula)
static org.dom4j.Element	toElement(String xml) 将 map 转为 element
static org.dom4j.Element	toElement(String rootName, Map<String,?> childMap)
static org.dom4j.Element	toElement(String rootName, Map<String,?> childMap, boolean cdata) 将 map 转为 element
static Map<String,Object>	toMap(org.dom4j.Document document)
static Map<String,Object>	toMap(org.dom4j.Document document, Class<?> mapClass)
static Map<String,Object>	toMap(org.dom4j.Document document, String formula)
static Map<String,Object>	toMap(org.dom4j.Document document, String formula, Class<?> mapClass)
static Map<String,Object>	toMap(org.dom4j.Element element)
static Map<String,Object>	toMap(org.dom4j.Element element, Class<?> mapClass)
static Map<String,Object>	toMap(org.dom4j.Element element, String formula)
static Map<String,Object>	toMap(org.dom4j.Element element, String formula, Class<?> mapClass) xml 解析为 map 有标签值 有属性值 不具有根标签
static Map<String,Object>	toMap(String xml)
static Map<String,Object>	toMap(String xml, Class<?> mapClass)
static Map<String,Object>	toMap(String xml, String formula)
static Map<String,Object>	toMap(String xml, String formula, Class<?> mapClass)
static String	unescape(String s) xml 反转义
static void	write(org.dom4j.Document document, File file)
static void	write(org.dom4j.Element element, File file) 将 xml 保存到文件
static void	write(String xml, File file)

Methods inherited from class java.lang.Object

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

Method Detail

isEscape

public static boolean isEscape(String s)

是否需要 xml 转义

Parameters:

s - s

Returns:

true 需要转义

escape

public static String escape(String s)

xml 转义

Parameters:

s - s

Returns:

转义字符

unescape

public static String unescape(String s)

xml 反转义

Parameters:

s - s

Returns:

原始字符

parse

public static org.dom4j.Element parse(org.dom4j.Element element,
                                      String formula)

获取解析的element

Parameters:

element - element

formula - 如: bean[1] > property > list > ref[0]:name=c [n] 下标 k:v 属性 不需要包含跟元素

Returns:

element

parseValue

public static String parseValue(org.dom4j.Element element,
                                String formula)

获取解析的element的value

Parameters:

element - element

formula - 如: bean[1] > property > list > ref[0]:name=c [n] 下标 k:v 属性 不需要包含跟元素

Returns:

element的value

getElements

public static Map<String,List<org.dom4j.Element>> getElements(org.dom4j.Element element)

获取节点元素

Parameters:

element - element

Returns:

element

getAttributes

public static Map<String,String> getAttributes(org.dom4j.Element e)

获取属性集

Parameters:

e - element

Returns:

values

getAttribute

public static String getAttribute(org.dom4j.Element e,
                                  String key)

获取属性

Parameters:

e - element

key - key

Returns:

value

toDocument

public static org.dom4j.Document toDocument(String xml)

xml 转 document

Parameters:

xml - xml

Returns:

document

toDocument

public static org.dom4j.Document toDocument(String rootName,
                                            Map<String,?> childMap)

toDocument

public static org.dom4j.Document toDocument(String rootName,
                                            Map<String,?> childMap,
                                            boolean cdata)

将 map 转为 document

Parameters:

rootName - 根节点名称

childMap - Map Map > Map > Map >

cdata - string是否使用CDATA修饰

Returns:

Document

toElement

public static org.dom4j.Element toElement(String xml)

将 map 转为 element

Parameters:

xml - xml

Returns:

element

toElement

public static org.dom4j.Element toElement(String rootName,
                                          Map<String,?> childMap)

toElement

public static org.dom4j.Element toElement(String rootName,
                                          Map<String,?> childMap,
                                          boolean cdata)

将 map 转为 element

Parameters:

rootName - 根节点名称

childMap - Map Map > Map > Map >

cdata - string是否使用CDATA修饰

Returns:

element

formatIndent

public static String formatIndent(String xml)

formatIndent

public static String formatIndent(String xml,
                                  boolean newLine)

formatIndent

public static String formatIndent(String xml,
                                  String indent)

formatIndent

public static String formatIndent(String xml,
                                  String indent,
                                  boolean newLine)

格式化 xml 缩进

Parameters:

xml - xml

indent - 缩进

newLine - 缩进后是否另起一行

Returns:

格式化后的 xml

formatExpandTag

public static String formatExpandTag(String xml)

formatExpandTag

public static String formatExpandTag(org.dom4j.Document document)

格式化 xml 禁止空标签自结束

Parameters:

document - document

Returns:

格式化后的 xml

format

public static String format(String xml)

format

public static String format(org.dom4j.Document document)

格式化 xml 默认格式

Parameters:

document - document

Returns:

格式化后的 xml

format

public static String format(String xml,
                            org.dom4j.io.OutputFormat format)

format

public static String format(org.dom4j.Document document,
                            org.dom4j.io.OutputFormat format)

格式化 xml

Parameters:

document - document

format - format

Returns:

格式化后的 xml

cleanComment

public static void cleanComment(org.dom4j.Document document)

去除注释

Parameters:

document - document

cleanComment

public static void cleanComment(org.dom4j.Element element)

去除注释

Parameters:

element - element

toBean

public static <T> T toBean(String xml,
                           Class<T> clazz)

toBean

public static <T> T toBean(String xml,
                           String formula,
                           Class<T> clazz)

toBean

public static <T> T toBean(String xml,
                           Class<T> clazz,
                           Map<String,Object> convertMapper)

toBean

public static <T> T toBean(String xml,
                           String formula,
                           Class<T> clazz,
                           Map<String,Object> convertMapper)

toBean

public static <T> T toBean(org.dom4j.Document document,
                           Class<T> clazz)

toBean

public static <T> T toBean(org.dom4j.Document document,
                           String formula,
                           Class<T> clazz)

toBean

public static <T> T toBean(org.dom4j.Document document,
                           Class<T> clazz,
                           Map<String,Object> convertMapper)

toBean

public static <T> T toBean(org.dom4j.Document document,
                           String formula,
                           Class<T> clazz,
                           Map<String,Object> convertMapper)

toBean

public static <T> T toBean(org.dom4j.Element element,
                           Class<T> clazz)

toBean

public static <T> T toBean(org.dom4j.Element element,
                           String formula,
                           Class<T> clazz)

toBean

public static <T> T toBean(org.dom4j.Element element,
                           Class<T> clazz,
                           Map<String,Object> convertMapper)

toBean

public static <T> T toBean(org.dom4j.Element element,
                           String formula,
                           Class<T> clazz,
                           Map<String,Object> convertMapper)

xml 转 bean

Type Parameters:

T - beanType

Parameters:

element - document

formula - 如: bean[1] > property > list > ref[0]:name=c 语法: [n] 下标 k:v 属性

clazz - beanClass

convertMapper - 属性转换map key:xml value:bean

Returns:

bean

toMap

public static Map<String,Object> toMap(String xml)

toMap

public static Map<String,Object> toMap(String xml,
                                       String formula)

toMap

public static Map<String,Object> toMap(String xml,
                                       Class<?> mapClass)

toMap

public static Map<String,Object> toMap(String xml,
                                       String formula,
                                       Class<?> mapClass)

toMap

public static Map<String,Object> toMap(org.dom4j.Document document)

toMap

public static Map<String,Object> toMap(org.dom4j.Document document,
                                       String formula)

toMap

public static Map<String,Object> toMap(org.dom4j.Document document,
                                       Class<?> mapClass)

toMap

public static Map<String,Object> toMap(org.dom4j.Document document,
                                       String formula,
                                       Class<?> mapClass)

toMap

public static Map<String,Object> toMap(org.dom4j.Element element)

toMap

public static Map<String,Object> toMap(org.dom4j.Element element,
                                       String formula)

toMap

public static Map<String,Object> toMap(org.dom4j.Element element,
                                       Class<?> mapClass)

toMap

public static Map<String,Object> toMap(org.dom4j.Element element,
                                       String formula,
                                       Class<?> mapClass)

xml 解析为 map 有标签值 有属性值 不具有根标签

Parameters:

element - element

formula - 如: bean[1] > property > list > ref[0]:name=c 语法: [n] 下标 k:v 属性

Returns:

map

toDomNode

public static Map<String,DomNode> toDomNode(String xml)

toDomNode

public static Map<String,DomNode> toDomNode(String xml,
                                            String formula)

toDomNode

public static Map<String,DomNode> toDomNode(org.dom4j.Document document)

toDomNode

public static Map<String,DomNode> toDomNode(org.dom4j.Document document,
                                            String formula)

toDomNode

public static Map<String,DomNode> toDomNode(org.dom4j.Element element)

toDomNode

public static Map<String,DomNode> toDomNode(org.dom4j.Element element,
                                            String formula)

xml 解析为 domNode 有标签值 有属性值 不具有根标签

Parameters:

element - element

formula - 如: bean[1] > property > list > ref[0]:name=c 语法: [n] 下标 k:v 属性

Returns:

domNode

asXml

public static String asXml(org.dom4j.Document document)

asXml

public static String asXml(org.dom4j.Element element)

转 xml

Parameters:

element - element

Returns:

xml

write

public static void write(String xml,
                         File file)
                  throws IOException

Throws:

IOException

write

public static void write(org.dom4j.Document document,
                         File file)
                  throws IOException

Throws:

IOException

write

public static void write(org.dom4j.Element element,
                         File file)
                  throws IOException

将 xml 保存到文件

Parameters:

element - element

file - 本地文件

Throws:

IOException