org.nutz.lang

类 Xmls

java.lang.Object

org.nutz.lang.Xmls

public abstract class Xmls
extends java.lang.Object

XML 的快捷帮助函数

构造器概要

构造器

构造器和说明
Xmls()

方法概要

限定符和类型	方法和说明
static NutMap	asMap(org.w3c.dom.Element ele) 根据一个 XML 节点，将其变成一个 Map。
static NutMap	asMap(org.w3c.dom.Element ele, boolean lowFirst) 根据一个 XML 节点，将其变成一个 Map。
static java.util.List<org.w3c.dom.Element>	children(org.w3c.dom.Element ele) 获取 XML 元素内所有子元素
static java.util.List<org.w3c.dom.Element>	children(org.w3c.dom.Element ele, java.lang.String regex) 获取 XML 元素内名字符合一个正则表达式的元素
static void	eachChildren(org.w3c.dom.Element ele, Each<org.w3c.dom.Element> callback) 迭代 XML 元素内所有子元素
static void	eachChildren(org.w3c.dom.Element ele, java.lang.String regex, Each<org.w3c.dom.Element> callback) 迭代 XML 元素内名字符合一个正则表达式的子元素
static void	eachChildren(org.w3c.dom.Element ele, java.lang.String regex, Each<org.w3c.dom.Element> callback, int off) 迭代 XML 元素内名字符合一个正则表达式的子元素
static org.w3c.dom.Element	firstChild(org.w3c.dom.Element ele) 获取 XML 元素内第一个子元素
static org.w3c.dom.Element	firstChild(org.w3c.dom.Element ele, java.lang.String regex) 获取 XML 元素内第一个名字所有符合一个正则表达式的子元素
static java.lang.String	get(org.w3c.dom.Element ele, java.lang.String subTagName) 获取某元素下某节点的全部文本内容（去掉左右空白）
static java.lang.String	getAttr(org.w3c.dom.Element ele, java.lang.String attrName) 从 XML 元素中得到指定属性的值，如该指定属性不存在，则返回Null
static java.util.Map<java.lang.String,java.lang.String>	getAttrs(org.w3c.dom.Element ele) 获取该 XML 元素内所有的属性的值，按照Map的形式返回
static org.w3c.dom.Element	getChild(org.w3c.dom.Element ele, int index) 从某个元素里获取一个指定下标的子元素
static org.w3c.dom.Element	getChild(org.w3c.dom.Element ele, int index, java.lang.String regex) 从某个元素里获取一个指定下标且指定名称的子元素
static org.w3c.dom.Element	getEle(org.w3c.dom.Element ele, java.lang.String xpath) 从一个 XML 元素开始，根据一条 XPath 获取一个元素
static java.util.List<org.w3c.dom.Element>	getEles(org.w3c.dom.Element ele, java.lang.String xpath) 从一个 XML 元素开始，根据一条 XPath 获取一组元素
static java.lang.String	getText(org.w3c.dom.Element ele)
static boolean	hasChild(org.w3c.dom.Element ele, java.lang.String regex) 判断某个元素下是否有子元素
static void	joinText(org.w3c.dom.Element ele, java.lang.StringBuilder sb)
static org.w3c.dom.Element	lastChild(org.w3c.dom.Element ele) 获取 XML 元素内最后一个子元素
static org.w3c.dom.Element	lastChild(org.w3c.dom.Element ele, java.lang.String regex) 获取 XML 元素内最后一个名字所有符合一个正则表达式的子元素
static java.lang.String	mapToXml(java.util.Map<java.lang.String,java.lang.Object> map) 将一个 Map 转换成 XML 类似: <xml> <key1>value1</key1> <key2>value2</key2> </xml>
static org.w3c.dom.Document	xml(java.io.File xmlFile)
static org.w3c.dom.Document	xml(java.io.File xmlFile, java.nio.charset.Charset charset) 快捷的解析 XML 文件的帮助方法
static org.w3c.dom.Document	xml(java.io.InputStream ins)
static org.w3c.dom.Document	xml(java.io.InputStream ins, java.nio.charset.Charset charset) 快捷的解析 XML 文件的帮助方法，它会主动关闭输入流
static javax.xml.parsers.DocumentBuilder	xmls() 帮你快速获得一个 DocumentBuilder，方便 XML 解析。
static NutMap	xmlToMap(java.lang.String xml) 将一个下面格式的 XML: <xml> <key1>value1</key1> <key2>value2</key2> </xml> 转换成一个 Map

从类继承的方法 java.lang.Object

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

构造器详细资料

Xmls

public Xmls()

方法详细资料

xmls

public static javax.xml.parsers.DocumentBuilder xmls()
                                              throws javax.xml.parsers.ParserConfigurationException

帮你快速获得一个 DocumentBuilder，方便 XML 解析。

返回:

一个 DocumentBuilder 对象

抛出:

javax.xml.parsers.ParserConfigurationException

xml

public static org.w3c.dom.Document xml(java.io.InputStream ins)

xml

public static org.w3c.dom.Document xml(java.io.InputStream ins,
                                       java.nio.charset.Charset charset)

快捷的解析 XML 文件的帮助方法，它会主动关闭输入流

参数:

ins - XML 文件输入流

返回:

Document 对象

xml

public static org.w3c.dom.Document xml(java.io.File xmlFile)

xml

public static org.w3c.dom.Document xml(java.io.File xmlFile,
                                       java.nio.charset.Charset charset)

快捷的解析 XML 文件的帮助方法

参数:

xmlFile - XML 文件

返回:

Document 对象

get

public static java.lang.String get(org.w3c.dom.Element ele,
                                   java.lang.String subTagName)

获取某元素下某节点的全部文本内容（去掉左右空白）

参数:

ele - 元素

subTagName - 子元素名

返回:

内容，null 表示子元素不存在, 空串表示元素没有对应文本内容

getText

public static java.lang.String getText(org.w3c.dom.Element ele)

joinText

public static void joinText(org.w3c.dom.Element ele,
                            java.lang.StringBuilder sb)

firstChild

public static org.w3c.dom.Element firstChild(org.w3c.dom.Element ele)

获取 XML 元素内第一个子元素

参数:

ele - XML 元素

返回:

子元素，null 表示不存在

firstChild

public static org.w3c.dom.Element firstChild(org.w3c.dom.Element ele,
                                             java.lang.String regex)

获取 XML 元素内第一个名字所有符合一个正则表达式的子元素

参数:

ele - XML 元素

regex - 元素名称正则表达式

返回:

子元素，null 表示不存在

getEle

public static org.w3c.dom.Element getEle(org.w3c.dom.Element ele,
                                         java.lang.String xpath)

从一个 XML 元素开始，根据一条 XPath 获取一个元素

参数:

ele - XML 元素

xpath - 要获取的元素的 XPath

返回:

元素，null 表示不存在

getChild

public static org.w3c.dom.Element getChild(org.w3c.dom.Element ele,
                                           int index)

从某个元素里获取一个指定下标的子元素

参数:

ele - XML 元素

index - 子元素下标（0 base）

返回:

子元素

getChild

public static org.w3c.dom.Element getChild(org.w3c.dom.Element ele,
                                           int index,
                                           java.lang.String regex)

从某个元素里获取一个指定下标且指定名称的子元素

参数:

ele - XML 元素

index - 子元素下标（0 base）

regex - 元素名称的正则表达式

返回:

子元素

lastChild

public static org.w3c.dom.Element lastChild(org.w3c.dom.Element ele)

获取 XML 元素内最后一个子元素

参数:

ele - XML 元素

返回:

子元素，null 表示不存在

lastChild

public static org.w3c.dom.Element lastChild(org.w3c.dom.Element ele,
                                            java.lang.String regex)

获取 XML 元素内最后一个名字所有符合一个正则表达式的子元素

参数:

ele - XML 元素

regex - 元素名称正则表达式

返回:

子元素，null 表示不存在

children

public static java.util.List<org.w3c.dom.Element> children(org.w3c.dom.Element ele)

获取 XML 元素内所有子元素

参数:

ele - XML 元素

返回:

一个子元素的列表

children

public static java.util.List<org.w3c.dom.Element> children(org.w3c.dom.Element ele,
                                                           java.lang.String regex)

获取 XML 元素内名字符合一个正则表达式的元素

参数:

ele - XML 元素

regex - 元素名称正则表达式

返回:

一个子元素的列表

eachChildren

public static void eachChildren(org.w3c.dom.Element ele,
                                Each<org.w3c.dom.Element> callback)

迭代 XML 元素内所有子元素

参数:

ele - XML 元素

callback - 回调

eachChildren

public static void eachChildren(org.w3c.dom.Element ele,
                                java.lang.String regex,
                                Each<org.w3c.dom.Element> callback)

迭代 XML 元素内名字符合一个正则表达式的子元素

参数:

ele - XML 元素

regex - 元素名称正则表达式

callback - 回调

hasChild

public static boolean hasChild(org.w3c.dom.Element ele,
                               java.lang.String regex)

判断某个元素下是否有子元素

参数:

ele - 元素

regex - 子元素名称的正则表达式，如果为 null，则元素内如果有任意元素都会返回 false

返回:

是否有子元素

eachChildren

public static void eachChildren(org.w3c.dom.Element ele,
                                java.lang.String regex,
                                Each<org.w3c.dom.Element> callback,
                                int off)

迭代 XML 元素内名字符合一个正则表达式的子元素

参数:

ele - XML 元素

regex - 元素名称正则表达式

callback - 回调

off - 偏移量。0 表示从第一个迭代。 -1 表示从最后一个迭代。-2表示从倒数第二个迭代

getAttrs

public static java.util.Map<java.lang.String,java.lang.String> getAttrs(org.w3c.dom.Element ele)

获取该 XML 元素内所有的属性的值，按照Map的形式返回

参数:

ele - XML 元素

返回:

所有属性的值

getAttr

public static java.lang.String getAttr(org.w3c.dom.Element ele,
                                       java.lang.String attrName)

从 XML 元素中得到指定属性的值，如该指定属性不存在，则返回Null

参数:

ele - XML 元素

返回:

该指定属性的值

asMap

public static NutMap asMap(org.w3c.dom.Element ele)

根据一个 XML 节点，将其变成一个 Map。

注意: 不支持混合节点

参数:

ele - 元素

返回:

一个 Map 对象

asMap

public static NutMap asMap(org.w3c.dom.Element ele,
                           boolean lowFirst)

根据一个 XML 节点，将其变成一个 Map。

注意: 不支持混合节点

参数:

ele - 元素

lowFirst - 是否把所有key的首字母都小写

返回:

一个 Map 对象

xmlToMap

public static NutMap xmlToMap(java.lang.String xml)

将一个下面格式的 XML:

 <xml>
 <key1>value1</key1>
 <key2>value2</key2>
 </xml>
 

转换成一个 Map

参数:

xml - XML 字符串

返回:

Map

mapToXml

public static java.lang.String mapToXml(java.util.Map<java.lang.String,java.lang.Object> map)

将一个 Map 转换成 XML 类似:

 <xml>
 <key1>value1</key1>
 <key2>value2</key2>
 </xml>
 

参数:

map - Map

返回:

XML 字符串

getEles

public static java.util.List<org.w3c.dom.Element> getEles(org.w3c.dom.Element ele,
                                                          java.lang.String xpath)

从一个 XML 元素开始，根据一条 XPath 获取一组元素

参数:

ele - XML 元素

xpath - 要获取的元素的 XPath

返回:

元素列表