Package gov.usgs.util

Class Ini

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

gov.usgs.util.Ini

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

Direct Known Subclasses:

Config

public class Ini
extends Properties

Ini is a Properties that supports sections. Format Rules:

• Empty lines are ignored.
• Leading and trailing white space are ignored.
• Comments must be on separate lines, and begin with '#' or ';'.
• Properties are key value pairs delimited by an equals: key = value
• Section Names are on separate lines, begin with '[' and end with ']'. Any whitespace around the brackets is ignored.
• Any properties before the first section are in the "null" section

Format Example:

 #comment about the global
 global = value

 # comment about this section
 ; another comment about this section
 [ Section Name ]
 section = value
 

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALTERNATE_COMMENT_START	String for representing an alternate comment start
static final String	COMMENT_START	String for representing a comment start
static final String	PROPERTY_DELIMITER	String to delimit properties
static final String	SECTION_END	String to represent a section end
static final String	SECTION_START	String to represent a section start

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor	Description
Ini()	Same as new Ini(null).
Ini(Properties properties)	Construct a new Ini with defaults.

Method Summary

Modifier and Type	Method	Description
String	getSectionProperty(String section, String key)	Get a section property.
HashMap<String,Properties>	getSections()
void	list(PrintStream out)	Write properties to a PrintStream.
void	list(PrintWriter out)	Write properties to a PrintWriter.
void	load(InputStream inStream)	Read an Ini input stream.
void	save(OutputStream out)	Write properties to an OutputStream.
Object	setSectionProperty(String section, String key, String value)	Set a section property.
void	store(OutputStream out, String header)	Calls write(new PrintWriter(out), header).
static void	write(Properties props, PrintWriter writer, String header)	Write an Ini format to a PrintWriter.

Methods inherited from class java.util.Properties

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, getProperty, getProperty, hashCode, isEmpty, keys, keySet, load, loadFromXML, merge, propertyNames, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, save, setProperty, size, store, storeToXML, storeToXML, storeToXML, stringPropertyNames, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

COMMENT_START

public static final String COMMENT_START

String for representing a comment start

See Also:

• Constant Field Values

ALTERNATE_COMMENT_START

public static final String ALTERNATE_COMMENT_START

String for representing an alternate comment start

See Also:

• Constant Field Values

SECTION_START

public static final String SECTION_START

String to represent a section start

See Also:

• Constant Field Values

SECTION_END

public static final String SECTION_END

String to represent a section end

See Also:

• Constant Field Values

PROPERTY_DELIMITER

public static final String PROPERTY_DELIMITER

String to delimit properties

See Also:

• Constant Field Values

Constructor Details

Ini

public Ini()

Same as new Ini(null).

Ini

public Ini(Properties properties)

Construct a new Ini with defaults.

Parameters:

properties - a Properties or Ini object with defaults. If an Ini object, also makes a shallow copy of sections.

Method Details

getSections

public HashMap<String,Properties> getSections()

Returns:

the section properties map.

getSectionProperty

public String getSectionProperty(String section,
 String key)

Get a section property.

Parameters:

section - the section, if null calls getProperty(key).

key - the property name.

Returns:

value or property, or null if no matching property found.

setSectionProperty

public Object setSectionProperty(String section,
 String key,
 String value)

Set a section property.

Parameters:

section - the section, if null calls super.setProperty(key, value).

key - the property name.

value - the property value.

Returns:

any previous value for key.

load

public void load(InputStream inStream)
          throws IOException

Read an Ini input stream.

Overrides:

load in class Properties

Parameters:

inStream - the input stream to read.

Throws:

IOException - if unable to parse input stream.

write

public static void write(Properties props,
 PrintWriter writer,
 String header)
                  throws IOException

Write an Ini format to a PrintWriter.

Parameters:

props - properties to write.

writer - the writer that writes.

header - an optioal header that will appear in comments at the start of the ini format.

Throws:

IOException - if unable to write output.

store

public void store(OutputStream out,
 String header)
           throws IOException

Calls write(new PrintWriter(out), header).

Overrides:

store in class Properties

Throws:

IOException

save

public void save(OutputStream out)

Write properties to an OutputStream.

Parameters:

out - the OutputStream used for writing.

list

public void list(PrintStream out)

Write properties to a PrintStream.

Overrides:

list in class Properties

Parameters:

out - the PrintStream used for writing.

list

public void list(PrintWriter out)

Write properties to a PrintWriter.

Overrides:

list in class Properties

Parameters:

out - the PrintWriter used for writing.