XMLProperties (hynnet-util API Documentation

java.lang.Object
- com.hynnet.util.XMLProperties

所有已实现的接口:

java.io.Serializable
```
public class XMLProperties
extends java.lang.Object
implements java.io.Serializable
```
以属性操作的方式操作XML文件的类。
支持直接通过 Key@Attribute=val.key2.valueKey 这样的格式直接获取数据。支持XML文件的自动备份。 Provides the the ability to use simple XML property files. Each property is in the form X.Y.Z, which would map to an XML snippet of:
```
 <X>
     <Y>
         <Z>someValue</Z>
     </Y>
 </X>
 
```
The XML file is passed in to the constructor and must be readable and writtable. Setting property values will automatically persist those value to disk.
另请参阅:
main方法的使用示例程序。, 序列化表格

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`XMLProperties.NodeChangeHandler` 节点修改动态代理处理类。
`static class`	`XMLProperties.PropertiesNodeList` 属性节点列表类。

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`BACKUP_FILE_EXT` 自动备份XML文件的后缀名。
`protected static org.slf4j.Logger`	`log` 日志对象。
`protected java.lang.String`	`m_strErrorMessage` 错误信息。
`static long`	`serialVersionUID`

构造器概要

构造器
构造器和说明
`XMLProperties()` 默认的构造函数，构造一个空的XML对象。
`XMLProperties(boolean bAutoBackup)` 构造一个空的XML对象。
`XMLProperties(boolean bAutoBackup, java.lang.String strBackupExtTimeFormater)` 构造一个空的XML对象。
`XMLProperties(byte[] datas)` 构造函数。
`XMLProperties(java.io.InputStream stream)` 构造函数。
`XMLProperties(java.io.InputStream stream, org.xml.sax.EntityResolver resolver, java.lang.String resourcePath)` 构造函数。
`XMLProperties(java.lang.String strFile)` Creates a new XMLProperties object.通过XML文件路径构造XML属性对象。
`XMLProperties(java.lang.String strFile, boolean bAutoBackup)` 通过XML文件路径构造XML属性对象。
`XMLProperties(java.lang.String strFile, boolean bAutoBackup, java.lang.String strBackupExtTimeFormater)` 通过XML文件路径构造XML属性对象。
`XMLProperties(java.lang.String strIn, java.lang.String strDefaultEncoding)` 以XML数据字符串构造一个新的 XMLProperties 对象。
`XMLProperties(java.lang.String strIn, java.lang.String strDefaultEncoding, boolean bAutoBackup)` 以XML数据字符串构造一个新的 XMLProperties 对象。
`XMLProperties(java.lang.String strIn, java.lang.String strDefaultEncoding, boolean bAutoBackup, java.lang.String strBackupExtTimeFormater)` 以XML数据字符串构造一个新的 XMLProperties 对象。

方法概要

方法
限定符和类型	方法和说明
`static void`	`addElemenText(org.w3c.dom.Document objDoc, org.w3c.dom.Element objElement, java.lang.String strSubElementName, java.lang.String strValue)` 在指定节点下的添加指定名字的带值子节点。
`static boolean`	`checkNode(org.w3c.dom.Node node)` 检查节点是否为有效节点。
`boolean`	`deleteProperty(java.lang.String strPath)` 删除节点。
`static java.lang.String`	`elementToXmlString(org.w3c.dom.Element objElement)` XML节点转字符串。
`boolean`	`exists()` 文件是否存在。
`protected void`	`finalize()` 类结束时调用
`StringList`	`findPropertyName(java.lang.String strNamePath)` 查找匹配的XML节点名称(支持正规表达式匹配)。
`static XMLProperties`	`fromStream(java.io.InputStream objStream)` 从输入流中加载XML属性对象。
`static XMLProperties`	`fromString(java.lang.String strData)` 通过字符串加载XML属性对象。
`static XMLProperties`	`fromString(java.lang.String strData, java.lang.String charsetName)` 通过字符串加载XML属性对象。
`StringList`	`getAllAttribute(java.lang.String path, java.lang.String attrName)` 获取匹配指定路径的所有节点的属性值。
`StringList`	`getAllProperty(java.lang.String namePath)` 获取所有匹配的XML节点所有值。
`java.lang.String`	`getAttribute(java.lang.String namePath)` getAttribute 取属性值
`java.lang.String`	`getAttribute(java.lang.String namePath, boolean isAllowEmpty)` getAttribute 取属性值
`boolean`	`getAttributeBoolean(java.lang.String strPathName, boolean bDefaultValue)` 取属性管理器中的boolean 型属性.
`double`	`getAttributeDouble(java.lang.String strPathName, double dbDefaultValue)` 取属性管理器中的Double 型属性.
`int`	`getAttributeInt(java.lang.String strPathName, int nDefaultValue)` 取属性管理器中的int 型属性.
`long`	`getAttributeLong(java.lang.String strPathName, long lDefaultValue)` 取属性管理器中的long 型属性.
`static java.lang.String`	`getAttributeValue(org.w3c.dom.Node objElement, java.lang.String strAttrName)` 获取指定节点的指定名称的属性值。
`static java.lang.String`	`getAttributeValue(org.w3c.dom.Node objElement, java.lang.String strAttrName, boolean isAllowEmpty)` 获取指定节点的指定名称的属性值。
`static org.w3c.dom.Node`	`getChildNode(org.w3c.dom.Node element, java.lang.String subElementName)` 获取指定节点第一个匹配的子节点。
`org.w3c.dom.Node`	`getChildNode(org.w3c.dom.Node element, java.lang.String eubElementName, boolean isForEdit)` 获取指定节点第一个匹配的子节点。
`static org.w3c.dom.NodeList`	`getChildNodes(org.w3c.dom.Node element, java.lang.String pathName)` 获取指定节点的指定路径的子节点列表。
`org.w3c.dom.NodeList`	`getChildNodes(org.w3c.dom.Node element, java.lang.String pathName, boolean isForEdit)` 获取指定节点的指定路径的子节点列表。
`java.lang.String[]`	`getChildrenProperties(java.lang.String strParentPath)` 获得下级XML节点的名字列表。
`java.lang.String`	`getDefaultPath()` 获取默认路径。
`org.w3c.dom.Document`	`getDocument()` 获取XML文档对象。
`org.w3c.dom.NodeList`	`getElements(java.lang.String namePath)` 获取符合条件的节点列表。
`org.w3c.dom.NodeList`	`getElements(java.lang.String namePath, boolean isForEdit)` 获取符合条件的节点列表。
`java.lang.String`	`getErrorMessage()` 获取错误信息。
`java.lang.String`	`getFileName()` 获取文档的文件名，包括文件路径。
`java.lang.String`	`getProperty(java.lang.String namePath)` 取XML节点值 Returns the value of the specified property.
`java.lang.String`	`getProperty(java.lang.String namePath, boolean isAllowEmpty)` getProperty 取XML节点值。
`boolean`	`getPropertyBoolean(java.lang.String pathName, boolean defaultValue)` 取属性管理器中的boolean 型XML节点值。
`double`	`getPropertyDouble(java.lang.String strPathName, double dbDefaultValue)` 取属性管理器中的Double 型XML节点值。
`int`	`getPropertyInt(java.lang.String strPathName, int nDefaultValue)` 取属性管理器中的int 型XML节点值。
`long`	`getPropertyLong(java.lang.String strPathName, long lDefaultValue)` 取属性管理器中的long 型XML节点值。
`long`	`getPropertyTime(java.lang.String strPathName)` 获取时间属性值。
`static java.lang.String`	`getText(org.w3c.dom.Node node)` 获取节点的文本。
`static java.lang.String`	`getText(org.w3c.dom.Node element, boolean isAllowEmpty)` 获取节点的文本。
`static java.lang.String`	`getText(org.w3c.dom.Node element, java.lang.String subElementName, boolean isAllowEmpty)` 获取节点下的子节点的文本。
`static boolean`	`getTextBool(org.w3c.dom.Node element, boolean defVal)` 获取指定节点的布尔值。
`static boolean`	`getTextBool(org.w3c.dom.Node objElement, java.lang.String strSubElement, boolean bDef)` 获取子节点的布尔值。
`static double`	`getTextDouble(org.w3c.dom.Node element, double defVal)` 获取指定节点的浮点值。
`static double`	`getTextDouble(org.w3c.dom.Node objElement, java.lang.String strSubElement, double fDef)` 获取子节点的浮点值。
`static int`	`getTextInt(org.w3c.dom.Node element, int defVal)` 获取指定节点的整型值。
`static int`	`getTextInt(org.w3c.dom.Node objElement, java.lang.String strSubElement, int nDef)` 获取子节点的整型值。
`static long`	`getTextLong(org.w3c.dom.Node element, long defVal)` 获取指定节点的长整型值。
`static long`	`getTextLong(org.w3c.dom.Node objElement, java.lang.String strSubElement, long lDef)` 获取子节点的长整型值。
`java.lang.String`	`getURI()` 获取文件URI。
`boolean`	`isAutoBackup()` 是否自动备份XML文件。
`protected boolean`	`isFile()`
`boolean`	`isLoad()` 判断文档是否已经正确装载。
`boolean`	`load(byte[] datas)` 从指定字符串加载XML。
`boolean`	`load(java.io.InputStream stream, org.xml.sax.EntityResolver resolver, java.lang.String resourcePath)` 从输入流中加载。
`boolean`	`load(java.lang.String strIn, java.lang.String strDefaultEncoding)` 从指定字符串加载XML。
`boolean`	`loadResource(java.lang.String strFileName)` 装载现有文件。
`boolean`	`loadResource(java.lang.String strFileName, boolean bForce)` 装载现有文件。
`boolean`	`loadResource(java.lang.String strIn, java.lang.String strDefaultEncoding)` 装载XML字符串数据。
`static void`	`main(java.lang.String[] args)` 使用示例函数。
`boolean`	`save()` 保存XML数据到文件。
`void`	`setAttribute(java.lang.String name, boolean value)` 设置属性值执行后要调用save()函数进行保存。
`void`	`setAttribute(java.lang.String name, double value)` 设置属性值执行后要调用save()函数进行保存。
`void`	`setAttribute(java.lang.String name, int value)` 设置属性值执行后要调用save()函数进行保存。
`void`	`setAttribute(java.lang.String name, long value)` 设置属性值执行后要调用save()函数进行保存。
`void`	`setAttribute(java.lang.String strPath, java.lang.String value)` setAttribute 设置属性值执行后要调用save()函数进行保存。
`void`	`setAutoBackup(boolean bAutoBackup)` 设置自动备份XML文件。
`boolean`	`setBackupExt(java.lang.String strBackupExtTimeFormater)` 设置自动备份文件的后缀名称的时间格式。
`static void`	`setChildText(org.w3c.dom.Node objElement, java.lang.String strSubElement, java.lang.String strValue)` 设置子节点文本值（只修改内存中的值，不能保存文件中）。
`void`	`setDefaultPath(java.lang.String strDefaultPath)` 设置默认路径。
`void`	`setDocument(org.w3c.dom.Document objDoc)` 设置指定XML文档对象。
`boolean`	`setFileName(java.lang.String strFileName)` 设置文档的文件名，如果装载的是已有文件，不能修改文件名。
`void`	`setProperty(java.lang.String strPath, boolean value)` 设置属性管理器中的boolean 型XML节点值。
`void`	`setProperty(java.lang.String strPath, double value)` 设置属性管理器中的Double 型XML节点值。
`void`	`setProperty(java.lang.String strPath, int value)` 设置属性管理器中的int 型XML节点值。
`void`	`setProperty(java.lang.String strPath, long value)` 设置属性管理器中的long 型XML节点值。
`void`	`setProperty(java.lang.String strPath, java.lang.String strValue)` 设置XML节点值。
`void`	`setPropertyTime(java.lang.String strPath, long lTimeValue)` 设置时间属性。
`static void`	`setText(org.w3c.dom.Node element, java.lang.String value)` 设置节点文本值（是否可保存到文件取决于Node的类型）。
`protected org.w3c.dom.NodeList`	`toProxyNode(org.w3c.dom.NodeList nodelist)`
`java.lang.String`	`toString()` 转字符串。
`static java.lang.String`	`toString(org.w3c.dom.Node node)` 节点转字符串。
`static java.lang.String`	`toValidElementName(java.lang.String strName)` 转换为有效的节点名称。

从类继承的方法 java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - serialVersionUID
```
public static final long serialVersionUID
```
    另请参阅:
    常量字段值
  - log
```
protected static final org.slf4j.Logger log
```
    日志对象。
  - m_strErrorMessage
```
protected java.lang.String m_strErrorMessage
```
    错误信息。
  - BACKUP_FILE_EXT
```
public static final java.lang.String BACKUP_FILE_EXT
```
    自动备份XML文件的后缀名。
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - XMLProperties
```
public XMLProperties()
```
    默认的构造函数，构造一个空的XML对象。默认自动备份，备份后缀名为年份。
  - XMLProperties
```
public XMLProperties(boolean bAutoBackup)
```
    构造一个空的XML对象。默认自动备份，备份后缀名为年份。
    
    参数:
    bAutoBackup - 是否自动备份。
  - XMLProperties
```
public XMLProperties(boolean bAutoBackup,
             java.lang.String strBackupExtTimeFormater)
```
    构造一个空的XML对象。默认自动备份，备份后缀名为年份。
    
    参数:
    bAutoBackup - 是否自动备份。
    strBackupExtTimeFormater - 备份文件后缀名格式，如 yyyy-MM-dd
  - XMLProperties
```
public XMLProperties(byte[] datas)
```
    构造函数。通过流加载。
    
    参数:
    datas - 字节数据。
  - XMLProperties
```
public XMLProperties(java.io.InputStream stream)
```
    构造函数。通过流加载。
    
    参数:
    stream -
  - XMLProperties
```
public XMLProperties(java.io.InputStream stream,
             org.xml.sax.EntityResolver resolver,
             java.lang.String resourcePath)
```
    构造函数。通过流加载。
    
    参数:
    stream - 输入流。
    resolver - 资源解析对象。
    resourcePath - 资源路径。对应XML的SystemId值。
  - XMLProperties
```
public XMLProperties(java.lang.String strFile)
```
    Creates a new XMLProperties object.通过XML文件路径构造XML属性对象。
    若装载一个不存在或非XML格式的文件会无法装载文件，调用save() 函数后会自动把正确的XML数据保存到该文件中。默认自动备份，备份后缀名为年份。
  - XMLProperties
```
public XMLProperties(java.lang.String strFile,
             boolean bAutoBackup)
```
    通过XML文件路径构造XML属性对象。
    若装载一个不存在或非XML格式的文件会无法装载文件，调用save() 函数后会自动把正确的XML数据保存到该文件中。默认自动备份，备份后缀名为年份。
    
    参数:
    bAutoBackup - 是否自动备份。
  - XMLProperties
```
public XMLProperties(java.lang.String strFile,
             boolean bAutoBackup,
             java.lang.String strBackupExtTimeFormater)
```
    通过XML文件路径构造XML属性对象。
    若装载一个不存在或非XML格式的文件会无法装载文件，调用save() 函数后会自动把正确的XML数据保存到该文件中。默认自动备份，备份后缀名为年份。
    
    参数:
    bAutoBackup - 是否自动备份。
    strBackupExtTimeFormater - 备份文件后缀名格式，如 yyyy-MM-dd
  - XMLProperties
```
public XMLProperties(java.lang.String strIn,
             java.lang.String strDefaultEncoding)
```
    以XML数据字符串构造一个新的 XMLProperties 对象。
    可以通过调用以下代码创建一个新的XML文件：
    objXML = new XMLProperties(null, null);
    objXML.setFileName("newFile.xml");
    objXML.setProperty("key", "value");
    objXML.save();
    默认自动备份，备份后缀名为年份。
    
    参数:
    strIn - String 输入字符串
    strDefaultEncoding - String 默认编码，
    null 取 Util.NativeCharSet
    "" 不进行编码转换
    字符串的编码方式
  - XMLProperties
```
public XMLProperties(java.lang.String strIn,
             java.lang.String strDefaultEncoding,
             boolean bAutoBackup)
```
    以XML数据字符串构造一个新的 XMLProperties 对象。
    可以通过调用以下代码创建一个新的XML文件：
    objXML = new XMLProperties(null, null);
    objXML.setFileName("newFile.xml");
    objXML.setProperty("key", "value");
    objXML.save();
    默认自动备份，备份后缀名为年份。
    
    参数:
    strIn - String 输入字符串
    strDefaultEncoding - String 默认编码，
    null 取 Util.NativeCharSet
    "" 不进行编码转换
    字符串的编码方式
    bAutoBackup - 是否自动备份。
  - XMLProperties
```
public XMLProperties(java.lang.String strIn,
             java.lang.String strDefaultEncoding,
             boolean bAutoBackup,
             java.lang.String strBackupExtTimeFormater)
```
    以XML数据字符串构造一个新的 XMLProperties 对象。
    可以通过调用以下代码创建一个新的XML文件：
    objXML = new XMLProperties(null, null);
    objXML.setFileName("newFile.xml");
    objXML.setProperty("key", "value");
    objXML.save();
    默认自动备份，备份后缀名为年份。
    
    参数:
    strIn - String 输入字符串
    strDefaultEncoding - String 默认编码，
    null 取 Util.NativeCharSet
    "" 不进行编码转换
    字符串的编码方式
    bAutoBackup - 是否自动备份。
    strBackupExtTimeFormater - 备份文件后缀名格式，如 yyyy-MM-dd
- 方法详细资料
  - fromStream
```
public static XMLProperties fromStream(java.io.InputStream objStream)
```
    从输入流中加载XML属性对象。
    
    参数:
    objStream -
    
    返回:
    失败返回null。
  - fromString
```
public static XMLProperties fromString(java.lang.String strData)
```
    通过字符串加载XML属性对象。
    
    参数:
    strData - UTF-8编码的XML数据。
    
    返回:
  - fromString
```
public static XMLProperties fromString(java.lang.String strData,
                       java.lang.String charsetName)
```
    通过字符串加载XML属性对象。
    
    参数:
    strData - XML数据。
    charsetName - 字符编码名称。
    
    返回:
  - finalize
```
protected void finalize()
```
    类结束时调用
    
    覆盖:
    
    finalize 在类中 java.lang.Object
  - getErrorMessage
```
public java.lang.String getErrorMessage()
```
    获取错误信息。
    
    返回:
  - getFileName
```
public java.lang.String getFileName()
```
    获取文档的文件名，包括文件路径。
    通过设置文件名可以创建新的XML属性文件。
    
    返回:
  - setFileName
```
public boolean setFileName(java.lang.String strFileName)
```
    设置文档的文件名，如果装载的是已有文件，不能修改文件名。
    通过设置文件名可以创建新的XML属性文件。
    
    返回:
    修改成功返回 true
  - getProperty
```
public java.lang.String getProperty(java.lang.String namePath,
                           boolean isAllowEmpty)
```
    getProperty 取XML节点值。
    
    参数:
    namePath - String 属性名
    允许 name1.name2@attr=attrValue.name3
    每节点的属性条件只支持一个
    isAllowEmpty - 是否允许空值。设置true时没有值或值为""均返回 ""；设置为false时没有值或值为""都返回 null。
    
    返回:
    返回属性值。
    另请参阅:
    main方法的使用示例程序。
  - getPropertyBoolean
```
public boolean getPropertyBoolean(java.lang.String pathName,
                         boolean defaultValue)
```
    取属性管理器中的boolean 型XML节点值。
    
    参数:
    pathName - 要返回的属性名.
    defaultValue - 当指定名字的属性不存在或不是合法的boolean类型时返回的值.
    
    返回:
    指定名字的Boolean 类型属性值.
    另请参阅:
    main方法的使用示例程序。
  - getPropertyDouble
```
public double getPropertyDouble(java.lang.String strPathName,
                       double dbDefaultValue)
```
    取属性管理器中的Double 型XML节点值。
    
    参数:
    strPathName - 要返回的属性名.
    dbDefaultValue - 当指定名字的属性不存在或不是合法的double类型时返回的值.
    
    返回:
    指定名字的Double 类型属性值.
    另请参阅:
    main方法的使用示例程序。
  - getPropertyInt
```
public int getPropertyInt(java.lang.String strPathName,
                 int nDefaultValue)
```
    取属性管理器中的int 型XML节点值。
    
    参数:
    strPathName - 要返回的属性名.
    nDefaultValue - 当指定名字的属性不存在或不是合法的int类型时返回的值.
    
    返回:
    指定名字的int 类型属性值.
    另请参阅:
    main方法的使用示例程序。
  - getPropertyLong
```
public long getPropertyLong(java.lang.String strPathName,
                   long lDefaultValue)
```
    取属性管理器中的long 型XML节点值。
    
    参数:
    strPathName - 要返回的属性名。
    lDefaultValue - 当指定名字的属性不存在或不是合法的int类型时返回的值。
    
    返回:
    指定名字的long 类型属性值。
    另请参阅:
    main方法的使用示例程序。
  - getPropertyTime
```
public long getPropertyTime(java.lang.String strPathName)
```
    获取时间属性值。
    
    参数:
    strPathName - 要返回的属性名。
    
    返回:
    没有设置，或值非合法的 yyyy-MM-dd HH:mm:ss 时间值时返回0。
  - findPropertyName
```
public StringList findPropertyName(java.lang.String strNamePath)
```
    查找匹配的XML节点名称(支持正规表达式匹配)。
    
    参数:
    strNamePath - 节点名称路径，支持 PropName@AttrName=AttrValue 格式，PropName和AttrValue支持正规表达式。
    
    返回:
    返回匹配的节点的节点名称路径列表。
    另请参阅:
    main方法的使用示例程序。
  - getAllProperty
```
public StringList getAllProperty(java.lang.String namePath)
```
    获取所有匹配的XML节点所有值。
```
 例如XML数据为：
 <?xml version="1.0" encoding="UTF-8"?>
 <B2C>
 <prop1>
     <prop2>
         <prop3>val1</prop3>
         <prop3>val2</prop3>
         <prop3>val3</prop3>
     </prop2>
 </prop1>
         但调用方法 objXML.getAllProperty("prop1.prop2.prop3")
         返回的StringList 包含三个字符串："val1"  "val2"  "val3"
 
```
    参数:
    namePath - 属性路径，支持 propName@attr=value 。
    
    返回:
    另请参阅:
    main方法的使用示例程序。
  - getProperty
```
public final java.lang.String getProperty(java.lang.String namePath)
```
    取XML节点值
    Returns the value of the specified property.
    如XML数据为：
    <?xml version="1.0" encoding="UTF-8"?>
    <data>
       <name1>
         <name2 attr="attrValue1">
              <name3>This is Data 1.</name3>
         </name2>
         <name2 attr="attrValue2">
              <name3>This is Data 2.</name3>
         </name2>
         <name2">
              <name4>This is Data 4.</name4>
         </name2>
         <name2">
              <name5>This is Data 5.</name5>
         </name2>
       </name1>
    </data>
    
    通过调用函数 objXML.getProperty("name1.name2@attr=attrValue1.name3"); 即可获得"This is Data 1."
    调用函数 objXML.getProperty("name1.name2@attr=attrValue2.name3"); 即可获得"This is Data 2."
    调用函数 objXML.getProperty("name1.name2.name4"); 即可获得"This is Data 4."
    调用函数 objXML.getProperty("name1.name2.name5"); 即可获得"This is Data 5."
    每节点的属性条件只支持一个
    
    参数:
    namePath - String 属性名
    允许 name1.name2@attr=attrValue.name3
    the name of the property to get.
    
    返回:
    返回属性值。不包含属性时返回null，属性值为""时返回""。
    the value of the specified property.
    另请参阅:
    main方法的使用示例程序。
  - getChildrenProperties
```
public java.lang.String[] getChildrenProperties(java.lang.String strParentPath)
```
    获得下级XML节点的名字列表。 Return all children property names of a parent property as a String array, or an empty array if the if there are no children. For example, given the properties X.Y.A, X.Y.B, and X.Y.C, then the child properties of X.Y are A, B, and C.
    
    参数:
    parent - the name of the parent property.
    
    返回:
    all child property values for the given parent.
    另请参阅:
    main方法的使用示例程序。
  - setProperty
```
public void setProperty(java.lang.String strPath,
               java.lang.String strValue)
```
    设置XML节点值。
    Sets the value of the specified property. If the property doesn't
    currently exist, it will be automatically created.
    执行后要调用save()函数进行保存。
    
    参数:
    strPath - String 属性名
    允许 name1.name2@attr=attrValue.name3
    the name of the property to set.
    每节点的属性条件只支持一个
    strValue - the new value for the property.
    另请参阅:
    main方法的使用示例程序。
  - setProperty
```
public void setProperty(java.lang.String strPath,
               boolean value)
```
    设置属性管理器中的boolean 型XML节点值。
    
    参数:
    strPath - 需要设置的属性名.
    value - boolean类型的属性值.
    另请参阅:
    main方法的使用示例程序。
  - setProperty
```
public void setProperty(java.lang.String strPath,
               double value)
```
    设置属性管理器中的Double 型XML节点值。
    
    参数:
    strPath - 需要设置的属性名.
    value - double类型的属性值.
    另请参阅:
    main方法的使用示例程序。
  - setProperty
```
public void setProperty(java.lang.String strPath,
               int value)
```
    设置属性管理器中的int 型XML节点值。
    
    参数:
    strPath - 需要设置的属性名.
    value - int类型的属性值.
    另请参阅:
    main方法的使用示例程序。
  - setProperty
```
public void setProperty(java.lang.String strPath,
               long value)
```
    设置属性管理器中的long 型XML节点值。
    
    参数:
    strPath - 需要设置的属性名.
    value - long类型的属性值.
    另请参阅:
    main方法的使用示例程序。
  - setPropertyTime
```
public void setPropertyTime(java.lang.String strPath,
                   long lTimeValue)
```
    设置时间属性。写入xml文件的时间格式为 yyyy-MM-dd HH:mm:ss 。
    
    参数:
    strPath -
    lTimeValue -
  - deleteProperty
```
public boolean deleteProperty(java.lang.String strPath)
```
    删除节点。Deletes the specified property.
    执行后要调用save()函数进行保存。
    
    参数:
    strPath - String 路径名
    允许 name1.name2@attr=attrValue.name3
    the property to delete.
    每节点的属性条件只支持一个
    
    返回:
    boolean 找到相应的节点并删除返回true
  - save
```
public boolean save()
```
    保存XML数据到文件。
    Saves the properties to disk as an XML document. A temporary file is used during the writing process for maximum safety.
    
    另请参阅:
    main方法的使用示例程序。
  - getAttribute
```
public java.lang.String getAttribute(java.lang.String namePath,
                            boolean isAllowEmpty)
```
    getAttribute 取属性值
    
    参数:
    namePath - String 属性路径名
    允许 name1.name2@attr=attrValue.attributeName
    attributeName 为需要获取的属性的名字。
    每节点的属性条件只支持一个
    isAllowEmpty - 是否允许空值。设置true时没有值或值为""均返回 ""；设置为false时没有值或值为""都返回 null。
    
    返回:
    String 返回属性值。
    另请参阅:
    main方法的使用示例程序。
  - getAttributeBoolean
```
public boolean getAttributeBoolean(java.lang.String strPathName,
                          boolean bDefaultValue)
```
    取属性管理器中的boolean 型属性.
    
    参数:
    strPathName - 要返回的属性名.
    bDefaultValue - 当指定名字的属性不存在或不是合法的boolean类型时返回的值.
    
    返回:
    指定名字的Boolean 类型属性值.
    另请参阅:
    main方法的使用示例程序。
  - getAttributeDouble
```
public double getAttributeDouble(java.lang.String strPathName,
                        double dbDefaultValue)
```
    取属性管理器中的Double 型属性.
    
    参数:
    strPathName - 要返回的属性名.
    dbDefaultValue - 当指定名字的属性不存在或不是合法的double类型时返回的值.
    
    返回:
    指定名字的Double 类型属性值.
    另请参阅:
    main方法的使用示例程序。
  - getAttributeInt
```
public int getAttributeInt(java.lang.String strPathName,
                  int nDefaultValue)
```
    取属性管理器中的int 型属性.
    
    参数:
    strPathName - 要返回的属性名.
    nDefaultValue - 当指定名字的属性不存在或不是合法的int类型时返回的值.
    
    返回:
    指定名字的int 类型属性值.
    另请参阅:
    main方法的使用示例程序。
  - getAttributeLong
```
public long getAttributeLong(java.lang.String strPathName,
                    long lDefaultValue)
```
    取属性管理器中的long 型属性.
    
    参数:
    strPathName - 要返回的属性名.
    lDefaultValue - 当指定名字的属性不存在或不是合法的int类型时返回的值.
    
    返回:
    指定名字的long 类型属性值.
    另请参阅:
    main方法的使用示例程序。
  - getAttribute
```
public java.lang.String getAttribute(java.lang.String namePath)
```
    getAttribute 取属性值
    
    参数:
    namePath - String 属性路径名
    允许 name1.name2@attr=attrValue.name3
    每节点的属性条件只支持一个
    
    返回:
    String 返回属性值，没有属性返回null，属性值为""时返回""。
    另请参阅:
    main方法的使用示例程序。
  - setAttribute
```
public void setAttribute(java.lang.String name,
                boolean value)
```
    设置属性值
    
    执行后要调用save()函数进行保存。
    
    参数:
    strPath - String 属性路径名
    属性名
    允许 name1.name2@attr=attrValue.attributeName
    attributeName 为设置的属性名称。
    每节点的属性条件只支持一个
    value - boolean boolean 类型的属性值
    另请参阅:
    main方法的使用示例程序。
  - setAttribute
```
public void setAttribute(java.lang.String name,
                double value)
```
    设置属性值
    
    执行后要调用save()函数进行保存。
    
    参数:
    strPath - String 属性路径名
    属性名
    允许 name1.name2@attr=attrValue.attributeName
    attributeName 为设置的属性名称。
    每节点的属性条件只支持一个
    value - double double 类型的属性值
    另请参阅:
    main方法的使用示例程序。
  - setAttribute
```
public void setAttribute(java.lang.String name,
                int value)
```
    设置属性值
    
    执行后要调用save()函数进行保存。
    
    参数:
    strPath - String 属性路径名
    属性名
    允许 name1.name2@attr=attrValue.attributeName
    attributeName 为设置的属性名称。
    每节点的属性条件只支持一个
    value - int int 类型的属性值
    另请参阅:
    main方法的使用示例程序。
  - setAttribute
```
public void setAttribute(java.lang.String name,
                long value)
```
    设置属性值
    
    执行后要调用save()函数进行保存。
    
    参数:
    strPath - String 属性路径名
    属性名
    允许 name1.name2@attr=attrValue.attributeName
    attributeName 为设置的属性名称。
    每节点的属性条件只支持一个
    value - long long 类型的属性值
    另请参阅:
    main方法的使用示例程序。
  - setAttribute
```
public void setAttribute(java.lang.String strPath,
                java.lang.String value)
```
    setAttribute 设置属性值
    
    执行后要调用save()函数进行保存。
    
    参数:
    strPath - String 属性路径名
    属性名
    允许 name1.name2@attr=attrValue.attributeName
    attributeName 为设置的属性名称。
    每节点的属性条件只支持一个
    value - String 属性值
    另请参阅:
    main方法的使用示例程序。
  - getAllAttribute
```
public StringList getAllAttribute(java.lang.String path,
                         java.lang.String attrName)
```
    获取匹配指定路径的所有节点的属性值。
    如XML数据为：
    <?xml version="1.0" encoding="UTF-8"?>
    <data>
         <name1 attr="attrValue1">
              <name2>This is Data 1.</name2>
              <name2>This is Data 1.2</name2>
         </name1>
         <name1 attr="attrValue2">
              <name2 attr="v1">This is Data 2.</name2>
              <name2 attr="v2">This is Data 2.2</name2>
         </name1>
    </data>
    
    通过调用函数 objXML.getAllAttribute("name1", "attr"); 返回"attrValue1" 和 "attrValue2" 两个值。
    调用函数 objXML.getAllAttribute("name1@attr=attrValue2.name2", "attr"); 即可获得"v1" 和 "v2" 两个值。
    
    参数:
    path - 路径名，允许允许 name1.name2@attr=attrValue.name3
    如果指定了属性值查找，只列出指定的节点的子节点。
    每节点的属性条件只支持一个
    attrName - 返回值的属性名称。
    
    返回:
    StringList 所有的属性值每个元素为字符串。
    另请参阅:
    main方法的使用示例程序。
  - getAttributeValue
```
public static final java.lang.String getAttributeValue(org.w3c.dom.Node objElement,
                                 java.lang.String strAttrName)
```
    获取指定节点的指定名称的属性值。
    
    参数:
    objElement - XML节点。
    strAttrName - 属性名称。
    
    返回:
    节点不存在或属性不存在时返回null。
  - getAttributeValue
```
public static final java.lang.String getAttributeValue(org.w3c.dom.Node objElement,
                                 java.lang.String strAttrName,
                                 boolean isAllowEmpty)
```
    获取指定节点的指定名称的属性值。
    
    参数:
    objElement - XML节点。
    strAttrName - 属性名称。 // * @param bAllowNull 返回值是否允许null值。
    isAllowEmpty - 是否允许空值。设置true时没有值或值为""均返回 ""；设置为false时没有值或值为""都返回 null。
    
    返回:
  - getChildNode
```
public static final org.w3c.dom.Node getChildNode(org.w3c.dom.Node element,
                            java.lang.String subElementName)
```
    获取指定节点第一个匹配的子节点。
    获取的节点修改后不会在原XMLProperties中体现，但不影响处理效率。
    
    参数:
    element -
    subElementName -
    
    返回:
    不存在指定子节点返回null。
  - getChildNode
```
public final org.w3c.dom.Node getChildNode(org.w3c.dom.Node element,
                            java.lang.String eubElementName,
                            boolean isForEdit)
```
    获取指定节点第一个匹配的子节点。
    
    参数:
    element -
    eubElementName -
    isForEdit - 节点是否修改有效。
    为true时，返回的节点进行了修改以后，调用源XMLProperties对象会体现改变，但运行效率稍差。
    为false时，返回的节点修改后不会在原XMLProperties中体现，但不影响处理效率。
    
    返回:
    不存在指定子节点返回null。
  - getChildNodes
```
public static final org.w3c.dom.NodeList getChildNodes(org.w3c.dom.Node element,
                                 java.lang.String pathName)
```
    获取指定节点的指定路径的子节点列表。
    获取的节点修改后不会在原XMLProperties中体现，但不影响处理效率。
    
    参数:
    element - XML节点对象。
    pathName - 属性路径，支持 propName@attr=value 。
    
    返回:
    返回的均为Element节点。
  - getChildNodes
```
public final org.w3c.dom.NodeList getChildNodes(org.w3c.dom.Node element,
                                 java.lang.String pathName,
                                 boolean isForEdit)
```
    获取指定节点的指定路径的子节点列表。
    获取的节点修改后不会在原XMLProperties中体现，但不影响处理效率。
    
    参数:
    element - XML节点对象。
    pathName - 属性路径，支持 propName@attr=value 。
    isForEdit - 节点是否修改有效。
    为true时，返回的节点进行了修改以后，调用源XMLProperties对象会体现改变，但运行效率稍差。
    为false时，返回的节点修改后不会在原XMLProperties中体现，但不影响处理效率。
    
    返回:
    返回的均为Element节点。
  - toProxyNode
```
protected org.w3c.dom.NodeList toProxyNode(org.w3c.dom.NodeList nodelist)
```
    参数:
    nodelist -
    
    返回:
  - getText
```
public static final java.lang.String getText(org.w3c.dom.Node node)
```
    获取节点的文本。
    
    参数:
    node - XML节点对象。
    
    返回:
    节点不存在时默认返回"";
  - getText
```
public static final java.lang.String getText(org.w3c.dom.Node element,
                       java.lang.String subElementName,
                       boolean isAllowEmpty)
```
    获取节点下的子节点的文本。
    
    参数:
    element - XML节点对象。
    subElementName - 子节点名称。当多个匹配时，只取第一个匹配值。
    isAllowEmpty - 是否允许空值。设置true时没有值或值为""均返回 ""；设置为false时没有值或值为""都返回 null。
    
    返回:
  - getText
```
public static final java.lang.String getText(org.w3c.dom.Node element,
                       boolean isAllowEmpty)
```
    获取节点的文本。
    
    参数:
    element - XML节点对象。
    isAllowEmpty - 是否允许空值。设置true时没有值或值为""均返回 ""；设置为false时没有值或值为""都返回 null。
    
    返回:
  - getTextBool
```
public static final boolean getTextBool(org.w3c.dom.Node objElement,
                  java.lang.String strSubElement,
                  boolean bDef)
```
    获取子节点的布尔值。
    
    参数:
    objElement -
    strSubElement -
    bDef -
    
    返回:
  - getTextBool
```
public static final boolean getTextBool(org.w3c.dom.Node element,
                  boolean defVal)
```
    获取指定节点的布尔值。
    
    参数:
    element -
    defVal -
    
    返回:
  - getTextDouble
```
public static final double getTextDouble(org.w3c.dom.Node objElement,
                   java.lang.String strSubElement,
                   double fDef)
```
    获取子节点的浮点值。
    
    参数:
    objElement -
    strSubElement -
    fDef -
    
    返回:
  - getTextDouble
```
public static final double getTextDouble(org.w3c.dom.Node element,
                   double defVal)
```
    获取指定节点的浮点值。
    
    参数:
    element -
    defVal -
    
    返回:
  - getTextInt
```
public static final int getTextInt(org.w3c.dom.Node objElement,
             java.lang.String strSubElement,
             int nDef)
```
    获取子节点的整型值。
    
    参数:
    objElement -
    strSubElement -
    nDef -
    
    返回:
  - getTextInt
```
public static final int getTextInt(org.w3c.dom.Node element,
             int defVal)
```
    获取指定节点的整型值。
    
    参数:
    element -
    defVal -
    
    返回:
  - getTextLong
```
public static final long getTextLong(org.w3c.dom.Node objElement,
               java.lang.String strSubElement,
               long lDef)
```
    获取子节点的长整型值。
    
    参数:
    objElement -
    strSubElement -
    lDef -
    
    返回:
  - getTextLong
```
public static final long getTextLong(org.w3c.dom.Node element,
               long defVal)
```
    获取指定节点的长整型值。
    
    参数:
    element -
    defVal -
    
    返回:
  - toValidElementName
```
public static java.lang.String toValidElementName(java.lang.String strName)
```
    转换为有效的节点名称。
```
 包括以下检查及转换：
 1. 纯数字，前面加下横线。
 
```
    参数:
    strName -
    
    返回:
  - setText
```
public static final void setText(org.w3c.dom.Node element,
           java.lang.String value)
```
    设置节点文本值（是否可保存到文件取决于Node的类型）。
    
    参数:
    element - 注意，提供的Node必须是可修改的才能保存，否则只能修改内存的值，save()后不能写入文件。
    value -
  - setChildText
```
public static final void setChildText(org.w3c.dom.Node objElement,
                java.lang.String strSubElement,
                java.lang.String strValue)
```
    设置子节点文本值（只修改内存中的值，不能保存文件中）。
    
    参数:
    objElement -
    strValue -
    另请参阅:
    setText(Node, String)
  - addElemenText
```
public static final void addElemenText(org.w3c.dom.Document objDoc,
                 org.w3c.dom.Element objElement,
                 java.lang.String strSubElementName,
                 java.lang.String strValue)
```
    在指定节点下的添加指定名字的带值子节点。
    
    参数:
    objDoc - XML文档对象。
    objElement - 节点对象。
    strSubElementName - 子节点名称。
    strValue - 子节点文本。
  - load
```
public boolean load(java.io.InputStream stream,
           org.xml.sax.EntityResolver resolver,
           java.lang.String resourcePath)
```
    从输入流中加载。
    
    参数:
    stream -
    resolver - 资源解析对象。
    resourcePath - 资源路径。对应XML的SystemId值。
    
    返回:
  - load
```
public boolean load(byte[] datas)
```
    从指定字符串加载XML。
    
    参数:
    datas - 字节数据。
    
    返回:
  - load
```
public boolean load(java.lang.String strIn,
           java.lang.String strDefaultEncoding)
```
    从指定字符串加载XML。
    
    参数:
    strIn -
    strDefaultEncoding -
    
    返回:
  - getDefaultPath
```
public java.lang.String getDefaultPath()
```
    获取默认路径。
    设置了此路径可以直接使用 .path 作为简化路径进行操作。
    
    返回:
  - getDocument
```
public org.w3c.dom.Document getDocument()
```
    获取XML文档对象。
    一般作为直接操作XML节点时使用。
    
    返回:
  - setDocument
```
public void setDocument(org.w3c.dom.Document objDoc)
```
    设置指定XML文档对象。
    
    参数:
    objDoc -
  - getElements
```
public final org.w3c.dom.NodeList getElements(java.lang.String namePath)
```
    获取符合条件的节点列表。
    
    参数:
    namePath - 属性路径，支持 propName@attr=value 。
    
    返回:
  - checkNode
```
public static boolean checkNode(org.w3c.dom.Node node)
```
    检查节点是否为有效节点。
    
    参数:
    node -
    
    返回:
  - getElements
```
public org.w3c.dom.NodeList getElements(java.lang.String namePath,
                               boolean isForEdit)
```
    获取符合条件的节点列表。
    
    参数:
    namePath - 属性路径，支持 propName@attr=value 。
    
    返回:
  - setDefaultPath
```
public void setDefaultPath(java.lang.String strDefaultPath)
```
    设置默认路径。
    设置了此路径可以直接使用 .path 作为简化路径进行操作。
    
    参数:
    strDefaultPath -
  - isLoad
```
public boolean isLoad()
```
    判断文档是否已经正确装载。
    
    返回:
  - isFile
```
protected boolean isFile()
```
  - exists
```
public boolean exists()
```
    文件是否存在。
    
    返回:
  - loadResource
```
public boolean loadResource(java.lang.String strFileName)
```
    装载现有文件。
    通过XML文件路径构造XML属性对象。
    若装载一个不存在或非XML格式的文件会无法装载文件，调用save() 函数后会自动把正确的XML数据保存到该文件中。
    
    参数:
    strFileName - 文件名。
    
    返回:
  - loadResource
```
public boolean loadResource(java.lang.String strFileName,
                   boolean bForce)
```
    装载现有文件。
    通过XML文件路径构造XML属性对象。
    若装载一个不存在或非XML格式的文件会无法装载文件，调用save() 函数后会自动把正确的XML数据保存到该文件中。
    
    参数:
    strFileName - 文件名。
    bForce - 是否强行设置当前类状态。
    
    返回:
  - loadResource
```
public boolean loadResource(java.lang.String strIn,
                   java.lang.String strDefaultEncoding)
```
    装载XML字符串数据。
    
    参数:
    strIn - String 输入字符串
    strDefaultEncoding - String 默认编码，
    null 取 Util.NativeCharSet
    "" 不进行编码转换
    字符串的编码方式
    
    返回:
  - getURI
```
public java.lang.String getURI()
```
    获取文件URI。
    
    返回:
  - isAutoBackup
```
public boolean isAutoBackup()
```
    是否自动备份XML文件。
    备份文件的后缀名通过 setBackupExt() 设置。
    默认自动备份，备份后缀名为年份。
    
    返回:
    自动备份时返回true。
  - setAutoBackup
```
public void setAutoBackup(boolean bAutoBackup)
```
    设置自动备份XML文件。
    备份文件的后缀名通过 setBackupExt() 设置。
    
    参数:
    bAutoBackup - 设置是否自动备份XML文件。
    另请参阅:
    main方法的使用示例程序。
  - setBackupExt
```
public boolean setBackupExt(java.lang.String strBackupExtTimeFormater)
```
    设置自动备份文件的后缀名称的时间格式。
    
    参数:
    strBackupExtTimeFormater - 备份文件后缀名格式，如 yyyy-MM-dd
    
    返回:
  - elementToXmlString
```
public static java.lang.String elementToXmlString(org.w3c.dom.Element objElement)
```
    XML节点转字符串。
    
    参数:
    objElement -
    
    返回:
    
    抛出:
    
    java.lang.Exception
  - toString
```
public java.lang.String toString()
```
    转字符串。
    
    覆盖:
    
    toString 在类中 java.lang.Object
  - toString
```
public static java.lang.String toString(org.w3c.dom.Node node)
```
    节点转字符串。
    
    参数:
    node -
    
    返回:
  - main
```
public static void main(java.lang.String[] args)
```
    使用示例函数。
```
 String strFile;
 String strPath; // "page@name=index.area@name=left"; //""      // "page@name=index.area";
 String strAttrName = "id"; // "id"; // "name";
 String strValue;
 XMLProperties propXML = null;
 List lstAttr = null;
 
 char chSplit = '%';
 
 HashMap mapData = new HashMap();
 Iterator iterData;
 StringList lstValue;
 
 File objFile;
 
 strValue = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" + "<data>"
            + "   <name>名称</name>\r\n" + "   <name id=\"2\">名称id=2</name>\r\n"
            + "   <name1>测试的name1</name1>\r\n"
            + "   <nametest><mydata>名称2</mydata></nametest>\r\n"
            + "   <name1>\r\n" + "     <name2 attr=\"attrValue1\">\r\n"
            + "          <name3>This is Data 1.</name3>\r\n"
            + "     </name2>\r\n"
            + "     <name2 attr=\"attrValue2\" id=\"2\">\r\n"
            + "          <name3>This is Data 2.</name3>\r\n" + "     </name2>"
            + "     <name2>\r\n"
            + "          <name4>This is Data 4.</name4>\r\n"
            + "     </name2>\r\n" + "     <name2>\r\n"
            + "          <name5>This is Data 5.</name5>\r\n"
            + "     </name2>\r\n" + "   </name1>\r\n" + "</data>";
 propXML = new XMLProperties(strValue, "GBK");
 log.info(strValue + "\r\nname :" + propXML.getProperty("name"));
 log.info("name id=2 :" + propXML.getProperty("name@id=2"));
 log.info("nametest.mydata :" + propXML.getProperty("nametest.mydata"));
 log.info("\r\nname1.name2@attr=attrValue1.name3 (正确值：This is Data 1.):"
          + propXML.getProperty("name1.name2@attr=attrValue1.name3"));
 log.info("\r\nname1.name2@attr=attrValue2.name3 (正确值：This is Data 2.):"
          + propXML.getProperty("name1.name2@attr=attrValue2.name3"));
 log.info("\r\nname1.name2.name4 (正确值：This is Data 4.):"
          + propXML.getProperty("name1.name2.name4"));
 log.info("\r\nname1.name2.name5 (正确值：This is Data 5.):"
          + propXML.getProperty("name1.name2.name5"));
 log.info("\r\nname all properties (正确值：名称 名称id=2): "
          + propXML.getAllProperty("name"));
 log.info("\r\nname.id attribute (正确值：2): "
          + propXML.getAttribute("name.id", true));
 log.info("\r\nname1.name2 all \"attr\" attribute (正确值：attrValue1 attrValue2 null null): "
          + propXML.getAllAttribute("name1.name2", "attr"));
 log.info("\r\nname1.name2@id=2 all \"attr\" attribute (正确值：attrValue2): "
          + propXML.getAllAttribute("name1.name2@id=2", "attr"));
 log.info("\r\nname1.name2@attr=* findPropertyName (正确值：name1.name2@attr=attrValue1 name1.name2@attr=attrValue2): "
          + propXML.findPropertyName("name1.name2@attr=*"));
 
 propXML = new XMLProperties("E://1890.xml");
 propXML.setAttribute("test", "testAttribute");
 propXML.save();
 
 
```
    参数:
    args -

类 XMLProperties

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

serialVersionUID

log

m_strErrorMessage

BACKUP_FILE_EXT

构造器详细资料

XMLProperties

XMLProperties

XMLProperties

XMLProperties

XMLProperties

XMLProperties

XMLProperties

XMLProperties

XMLProperties

XMLProperties

XMLProperties

XMLProperties

方法详细资料

fromStream

fromString

fromString

finalize

getErrorMessage

getFileName

setFileName

getProperty

getPropertyBoolean

getPropertyDouble

getPropertyInt

getPropertyLong

getPropertyTime

findPropertyName

getAllProperty

getProperty

getChildrenProperties

setProperty

setProperty

setProperty

setProperty

setProperty

setPropertyTime

deleteProperty

save

getAttribute

getAttributeBoolean

getAttributeDouble

getAttributeInt

getAttributeLong

getAttribute

setAttribute

setAttribute

setAttribute

setAttribute

setAttribute

getAllAttribute

getAttributeValue

getAttributeValue

getChildNode

getChildNode

getChildNodes

getChildNodes

toProxyNode

getText

getText

getText

getTextBool

getTextBool

getTextDouble

getTextDouble

getTextInt

getTextInt

getTextLong

getTextLong