tfw.base.util.properties

Class PropertiesToolT

java.lang.Object

tfw.base.util.properties.PropertiesToolT

Direct Known Subclasses:

PropertiesToolE, PropertiesToolP

public class PropertiesToolT
extends java.lang.Object

A pack of tools for reading and writing properties file(s).
Throws exceptions.

Author:

Typhoon.Free.Wolf

Constructor Summary

Constructors

Constructor and Description
PropertiesToolT()

Method Summary

Modifier and Type	Method and Description
static boolean	fillFromFile(java.util.Properties props, java.lang.String strFileName) Fills properties from a properties file.
static boolean	fillFromPropertiesFile(java.util.Properties props, java.lang.String strFileName) Fills properties from a traditional properties file.
static boolean	fillFromXmlFile(java.util.Properties props, java.lang.String strFileName) Fills properties from an XML properties file.
private static java.lang.String	generateComment() Generates a comment.
private static boolean	isXmlFile(java.lang.String strFileName) Judges file type by suffix, not a formal way.
static java.util.Properties	loadFromFile(java.lang.String strFileName) Loads properties from a properties file.
static java.util.Properties	loadFromPropertiesFile(java.lang.String strFileName) Loads properties from a traditional properties file.
static java.util.Properties	loadFromXmlFile(java.lang.String strFileName) Loads properties from an XML properties file.
static boolean	saveToFile(java.util.Properties props, java.lang.String strFileName) Saves properties to a properties file.
static boolean	saveToPropertiesFile(java.util.Properties props, java.lang.String strFileName) Saves properties to a traditional properties file.
static boolean	saveToXmlFile(java.util.Properties props, java.lang.String strFileName) Saves properties to an XML properties file.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesToolT

public PropertiesToolT()

Method Detail

fillFromPropertiesFile

public static boolean fillFromPropertiesFile(java.util.Properties props,
                                             java.lang.String strFileName)
                                      throws java.io.IOException

Fills properties from a traditional properties file.

Parameters:

props - - Properties.

strFileName - - File name.

Returns:

A boolean flag that indicates whether successfully filled properties from file:

• true : Successfully filled.
  
• false: Failed filling.
  

Throws:

java.io.IOException - .

fillFromXmlFile

public static boolean fillFromXmlFile(java.util.Properties props,
                                      java.lang.String strFileName)
                               throws java.io.IOException

Fills properties from an XML properties file.

Parameters:

props - - Properties.

strFileName - - File name.

Returns:

A boolean flag that indicates whether successfully filled properties from file:

• true : Successfully filled.
  
• false: Failed filling.
  

Throws:

java.io.IOException - .

fillFromFile

public static boolean fillFromFile(java.util.Properties props,
                                   java.lang.String strFileName)
                            throws java.io.IOException

Fills properties from a properties file.

Parameters:

props - - Properties.

strFileName - - File name.

Returns:

A boolean flag that indicates whether successfully filled properties from file:

• true : Successfully filled.
  
• false: Failed filling.
  

Throws:

java.io.IOException - .

saveToPropertiesFile

public static boolean saveToPropertiesFile(java.util.Properties props,
                                           java.lang.String strFileName)
                                    throws java.io.IOException

Saves properties to a traditional properties file.

Parameters:

props - - Properties.

strFileName - - File name.

Returns:

A boolean flag that indicates whether successfully saved:

• true : Successfully saved.
  
• false: Failed saving.
  

Throws:

java.io.IOException - .

saveToXmlFile

public static boolean saveToXmlFile(java.util.Properties props,
                                    java.lang.String strFileName)
                             throws java.io.IOException

Saves properties to an XML properties file.

Parameters:

props - - Properties.

strFileName - - File name.

Returns:

A boolean flag that indicates whether successfully saved:

• true : Successfully saved.
  
• false: Failed saving.
  

Throws:

java.io.IOException - .

saveToFile

public static boolean saveToFile(java.util.Properties props,
                                 java.lang.String strFileName)
                          throws java.io.IOException

Saves properties to a properties file.

Parameters:

props - - Properties.

strFileName - - File name.

Returns:

A boolean flag that indicates whether successfully saved:

• true : Successfully saved.
  
• false: Failed saving.
  

Throws:

java.io.IOException - .

loadFromPropertiesFile

public static java.util.Properties loadFromPropertiesFile(java.lang.String strFileName)
                                                   throws java.io.IOException

Loads properties from a traditional properties file.

Parameters:

strFileName - - File name.

Returns:

The properties that loaded from file; could be null.

Throws:

java.io.IOException - .

loadFromXmlFile

public static java.util.Properties loadFromXmlFile(java.lang.String strFileName)
                                            throws java.io.IOException

Loads properties from an XML properties file.

Parameters:

strFileName - - File name.

Returns:

The properties that loaded from file; could be null.

Throws:

java.io.IOException - .

loadFromFile

public static java.util.Properties loadFromFile(java.lang.String strFileName)
                                         throws java.io.IOException

Loads properties from a properties file.

Parameters:

strFileName - - File name.

Returns:

The properties that loaded from file; could be null.

Throws:

java.io.IOException - .

generateComment

private static java.lang.String generateComment()

Generates a comment.

Returns:

Default comment.

isXmlFile

private static boolean isXmlFile(java.lang.String strFileName)

Judges file type by suffix, not a formal way.

Parameters:

strFileName - - File name.

Returns:

A boolean flag:

• true: Is an XML file.
  
• false: Not an XML file.