Xmls (Nutz 1.r.61.r2 API)

java.lang.Object
- org.nutz.lang.Xmls

```
public abstract class Xmls
extends Object
```
XML 的快捷帮助函数

作者:

zozoh(zozohtnt@gmail.com)

字段概要

字段
限定符和类型字段和说明

static String HEAD

字段
限定符和类型	字段和说明
`static String`	`HEAD`

构造器概要

构造器
构造器和说明

Xmls()

构造器
构造器和说明
`Xmls()`

方法概要

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

- 字段详细资料
  - HEAD
```
public static String HEAD
```
- 构造器详细资料
  - Xmls
```
public Xmls()
```
- 方法详细资料
  - xmls
```
public static DocumentBuilder xmls()
                            throws ParserConfigurationException
```
    帮你快速获得一个 DocumentBuilder，方便 XML 解析。
    
    返回:
    
    一个 DocumentBuilder 对象
    
    抛出:
    
    ParserConfigurationException
  - xml
```
public static Document xml(InputStream ins)
```
  - xml
```
public static Document xml(InputStream ins,
                           Charset charset)
```
    快捷的解析 XML 文件的帮助方法，它会主动关闭输入流
    
    参数:
    
    ins - XML 文件输入流
    
    返回:
    
    Document 对象
  - xml
```
public static Document xml(File xmlFile)
```
  - xml
```
public static Document xml(File xmlFile,
                           Charset charset)
```
    快捷的解析 XML 文件的帮助方法
    
    参数:
    
    xmlFile - XML 文件
    
    返回:
    
    Document 对象
  - get
```
public static String get(Element ele,
                         String subTagName)
```
    获取某元素下某节点的全部文本内容（去掉左右空白）
    
    参数:
    
    ele - 元素
    
    subTagName - 子元素名
    
    返回:
    
    内容，null 表示子元素不存在, 空串表示元素没有对应文本内容
  - getText
```
public static String getText(Element ele)
```
  - joinText
```
public static void joinText(Element ele,
                            StringBuilder sb)
```
  - firstChild
```
public static Element firstChild(Element ele)
```
    获取 XML 元素内第一个子元素
    
    参数:
    
    ele - XML 元素
    
    返回:
    
    子元素，null 表示不存在
  - firstChild
```
public static Element firstChild(Element ele,
                                 String regex)
```
    获取 XML 元素内第一个名字所有符合一个正则表达式的子元素
    
    参数:
    
    ele - XML 元素
    
    regex - 元素名称正则表达式
    
    返回:
    
    子元素，null 表示不存在
  - getEle
```
public static Element getEle(Element ele,
                             String xpath)
```
    从一个 XML 元素开始，根据一条 XPath 获取一个元素
    
    参数:
    
    ele - XML 元素
    
    xpath - 要获取的元素的 XPath
    
    返回:
    
    元素，null 表示不存在
  - getChild
```
public static Element getChild(Element ele,
                               int index)
```
    从某个元素里获取一个指定下标的子元素
    
    参数:
    
    ele - XML 元素
    
    index - 子元素下标（0 base）
    
    返回:
    
    子元素
  - getChild
```
public static Element getChild(Element ele,
                               int index,
                               String regex)
```
    从某个元素里获取一个指定下标且指定名称的子元素
    
    参数:
    
    ele - XML 元素
    
    index - 子元素下标（0 base）
    
    regex - 元素名称的正则表达式
    
    返回:
    
    子元素
  - lastChild
```
public static Element lastChild(Element ele)
```
    获取 XML 元素内最后一个子元素
    
    参数:
    
    ele - XML 元素
    
    返回:
    
    子元素，null 表示不存在
  - lastChild
```
public static Element lastChild(Element ele,
                                String regex)
```
    获取 XML 元素内最后一个名字所有符合一个正则表达式的子元素
    
    参数:
    
    ele - XML 元素
    
    regex - 元素名称正则表达式
    
    返回:
    
    子元素，null 表示不存在
  - children
```
public static List<Element> children(Element ele)
```
    获取 XML 元素内所有子元素
    
    参数:
    
    ele - XML 元素
    
    返回:
    
    一个子元素的列表
  - children
```
public static List<Element> children(Element ele,
                                     String regex)
```
    获取 XML 元素内名字符合一个正则表达式的元素
    
    参数:
    
    ele - XML 元素
    
    regex - 元素名称正则表达式
    
    返回:
    
    一个子元素的列表
  - eachChildren
```
public static void eachChildren(Element ele,
                                Each<Element> callback)
```
    迭代 XML 元素内所有子元素
    
    参数:
    
    ele - XML 元素
    
    callback - 回调
  - eachChildren
```
public static void eachChildren(Element ele,
                                String regex,
                                Each<Element> callback)
```
    迭代 XML 元素内名字符合一个正则表达式的子元素
    
    参数:
    
    ele - XML 元素
    
    regex - 元素名称正则表达式
    
    callback - 回调
  - hasChild
```
public static boolean hasChild(Element ele,
                               String regex)
```
    判断某个元素下是否有子元素
    
    参数:
    
    ele - 元素
    
    regex - 子元素名称的正则表达式，如果为 null，则元素内如果有任意元素都会返回 false
    
    返回:
    
    是否有子元素
  - eachChildren
```
public static void eachChildren(Element ele,
                                String regex,
                                Each<Element> callback,
                                int off)
```
    迭代 XML 元素内名字符合一个正则表达式的子元素
    
    参数:
    
    ele - XML 元素
    
    regex - 元素名称正则表达式
    
    callback - 回调
    
    off - 偏移量。0 表示从第一个迭代。 -1 表示从最后一个迭代。-2表示从倒数第二个迭代
  - getAttrs
```
public static Map<String,String> getAttrs(Element ele)
```
    获取该 XML 元素内所有的属性的值，按照Map的形式返回
    
    参数:
    
    ele - XML 元素
    
    返回:
    
    所有属性的值
  - getAttr
```
public static String getAttr(Element ele,
                             String attrName)
```
    从 XML 元素中得到指定属性的值，如该指定属性不存在，则返回Null
    
    参数:
    
    ele - XML 元素
    
    返回:
    
    该指定属性的值
  - asMap
```
public static NutMap asMap(Element ele)
```
    根据一个 XML 节点，将其变成一个 Map。
    注意: 不支持混合节点
    
    参数:
    
    ele - 元素
    
    返回:
    
    一个 Map 对象
  - asMap
```
public static NutMap asMap(Element ele,
                           boolean lowFirst)
```
    根据一个 XML 节点，将其变成一个 Map。
    注意: 不支持混合节点
    
    参数:
    
    ele - 元素
    
    lowFirst - 是否把所有key的首字母都小写
    
    返回:
    
    一个 Map 对象
  - asMap
```
public static NutMap asMap(Element ele,
                           boolean lowFirst,
                           boolean dupAsList)
```
  - xmlToMap
```
public static NutMap xmlToMap(String xml)
```
    将一个下面格式的 XML:
```
 <xml>
 <key1>value1</key1>
 <key2>value2</key2>
 </xml>
 
```
    转换成一个 Map
    参数:
    
    xml - XML 字符串
    
    返回:
    
    Map
  - mapToXml
```
public static String mapToXml(Map<String,Object> map)
```
    将一个 Map 转换成 XML 类似:
```
 <xml>
 <key1>value1</key1>
 <key2>value2</key2>
 </xml>
 
```
    参数:
    
    map - Map
    
    返回:
    
    XML 字符串
  - mapToXml
```
public static String mapToXml(String root,
                              Map<String,Object> map)
```
  - getEles
```
public static List<Element> getEles(Element ele,
                                    String xpath)
```
    从一个 XML 元素开始，根据一条 XPath 获取一组元素
    
    参数:
    
    ele - XML 元素
    
    xpath - 要获取的元素的 XPath
    
    返回:
    
    元素列表

类 Xmls

字段概要

构造器概要

方法概要

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

字段详细资料

HEAD

构造器详细资料

Xmls

方法详细资料

xmls

xml

xml

xml

xml

get

getText

joinText

firstChild

firstChild

getEle

getChild

getChild

lastChild

lastChild

children

children

eachChildren

eachChildren

hasChild

eachChildren

getAttrs

getAttr

asMap

asMap

asMap

xmlToMap

mapToXml

mapToXml

getEles