Properties

Properties

Properties()

Creates an empty property list with no default values.

Properties

Properties(defaults: Properties!)

Creates an empty property list with the specified defaults.

clear

open fun clear(): Unit

clone

open fun clone(): Any

compute

open fun compute(
    key: Any!, 
    remappingFunction: BiFunction<in Any!, in Any?, *>
): Any?

computeIfAbsent

open fun computeIfAbsent(
    key: Any!, 
    mappingFunction: Function<in Any!, *>
): Any!

computeIfPresent

open fun computeIfPresent(
    key: Any!, 
    remappingFunction: BiFunction<in Any!, in Any, *>
): Any?

contains

open fun contains(value: Any!): Boolean

containsKey

open fun containsKey(key: Any!): Boolean

containsValue

open fun containsValue(value: Any!): Boolean

elements

open fun elements(): Enumeration<Any!>!

equals

open fun equals(other: Any?): Boolean

forEach

open fun forEach(action: BiConsumer<in Any!, in Any!>): Unit

get

open fun get(key: Any!): Any?

getOrDefault

open fun getOrDefault(
    key: Any!, 
    defaultValue: Any!
): Any!

getProperty

open fun getProperty(key: String!): String!

Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns null if the property is not found.

getProperty

open fun getProperty(
    key: String!, 
    defaultValue: String!
): String!

Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns the default value argument if the property is not found.

hashCode

open fun hashCode(): Int

isEmpty

open fun isEmpty(): Boolean

keys

open fun keys(): Enumeration<Any!>!

list

open fun list(out: PrintStream!): Unit

Prints this property list out to the specified output stream. This method is useful for debugging.

list

open fun list(out: PrintWriter!): Unit

Prints this property list out to the specified output stream. This method is useful for debugging.

load

open fun load(reader: Reader!): Unit

Reads a property list (key and element pairs) from the input character stream in a simple line-oriented format.

Properties are processed in terms of lines. There are two kinds of line, natural lines and logical lines. A natural line is defined as a line of characters that is terminated either by a set of line terminator characters (\n or \r or \r\n) or by the end of the stream. A natural line may be either a blank line, a comment line, or hold all or some of a key-element pair. A logical line holds all the data of a key-element pair, which may be spread out across several adjacent natural lines by escaping the line terminator sequence with a backslash character \. Note that a comment line cannot be extended in this manner; every natural line that is a comment must have its own comment indicator, as described below. Lines are read from input until the end of the stream is reached.

A natural line that contains only white space characters is considered blank and is ignored. A comment line has an ASCII '#' or '!' as its first non-white space character; comment lines are also ignored and do not encode key-element information. In addition to line terminators, this format considers the characters space (' ', '\u005Cu0020'), tab ('\t', '\u005Cu0009'), and form feed ('\f', '\u005Cu000C') to be white space.

If a logical line is spread across several natural lines, the backslash escaping the line terminator sequence, the line terminator sequence, and any white space at the start of the following line have no affect on the key or element values. The remainder of the discussion of key and element parsing (when loading) will assume all the characters constituting the key and element appear on a single natural line after line continuation characters have been removed. Note that it is not sufficient to only examine the character preceding a line terminator sequence to decide if the line terminator is escaped; there must be an odd number of contiguous backslashes for the line terminator to be escaped. Since the input is processed from left to right, a non-zero even number of 2n contiguous backslashes before a line terminator (or elsewhere) encodes n backslashes after escape processing.

The key contains all of the characters in the line starting with the first non-white space character and up to, but not including, the first unescaped '=', ':', or white space character other than a line terminator. All of these key termination characters may be included in the key by escaping them with a preceding backslash character; for example,

\:\=

would be the two-character key ":=". Line terminator characters can be included using \r and \n escape sequences. Any white space after the key is skipped; if the first non-white space character after the key is '=' or ':', then it is ignored and any white space characters after it are also skipped. All remaining characters on the line become part of the associated element string; if there are no remaining characters, the element is the empty string "". Once the raw character sequences constituting the key and element are identified, escape processing is performed as described above.

As an example, each of the following three lines specifies the key "Truth" and the associated element value "Beauty":

Truth = Beauty
   Truth:Beauty
  Truth                    :Beauty
  

fruits                           apple, banana, pear, \
                                   cantaloupe, watermelon, \
                                   kiwi, mango
  

"apple, banana, pear, cantaloupe, watermelon, kiwi, mango"

As a third example, the line:

cheeses
  

Characters in keys and elements can be represented in escape sequences similar to those used for character and string literals (see sections {@jls 3.3} and {@jls 3.10.6} of The Java Language Specification). The differences from the character escape sequences and Unicode escapes used for characters and strings are:

• Octal escapes are not recognized.
• The character sequence \b does not represent a backspace character.
• The method does not treat a backslash character, \, before a non-valid escape character as an error; the backslash is silently dropped. For example, in a Java string the sequence "\z" would cause a compile time error. In contrast, this method silently drops the backslash. Therefore, this method treats the two character sequence "\b" as equivalent to the single character 'b'.
• Escapes are not necessary for single and double quotes; however, by the rule above, single and double quote characters preceded by a backslash still yield single and double quote characters, respectively.
• Only a single 'u' character is allowed in a Unicode escape sequence.

The specified stream remains open after this method returns.

load

open fun load(inStream: InputStream!): Unit

Reads a property list (key and element pairs) from the input byte stream. The input stream is in a simple line-oriented format as specified in load(Reader) and is assumed to use the ISO 8859-1 character encoding; that is each byte is one Latin1 character. Characters not in Latin1, and certain special characters, are represented in keys and elements using Unicode escapes as defined in section {@jls 3.3} of The Java Language Specification.

The specified stream remains open after this method returns.

loadFromXML

open fun loadFromXML(in: InputStream!): Unit

Loads all of the properties represented by the XML document on the specified input stream into this properties table.

The XML document must have the following DOCTYPE declaration:

<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
  

An implementation is required to read XML documents that use the "UTF-8" or "UTF-16" encoding. An implementation may support additional encodings.

The specified stream is closed after this method returns.

merge

open fun merge(
    key: Any!, 
    value: Any, 
    remappingFunction: BiFunction<in Any, in Any, *>
): Any?

propertyNames

open fun propertyNames(): Enumeration<*>!

Returns an enumeration of all the keys in this property list, including distinct keys in the default property list if a key of the same name has not already been found from the main properties list.

put

open fun put(
    key: Any!, 
    value: Any!
): Any?

putAll

open fun putAll(from: Map<*, *>): Unit

putIfAbsent

open fun putIfAbsent(
    key: Any!, 
    value: Any!
): Any?

remove

open fun remove(key: Any!): Any?

remove

open fun remove(
    key: Any!, 
    value: Any!
): Boolean

replace

open fun replace(
    key: Any!, 
    oldValue: Any!, 
    newValue: Any!
): Boolean

replace

open fun replace(
    key: Any!, 
    value: Any!
): Any?

replaceAll

open fun replaceAll(function: BiFunction<in Any!, in Any!, *>): Unit

save

open fun save(
    out: OutputStream!, 
    comments: String!
): Unit

Deprecated: This method does not throw an IOException if an I/O error occurs while saving the property list. The preferred way to save a properties list is via the store(OutputStream out, String comments) method or the storeToXML(OutputStream os, String comment) method.

Calls the store(OutputStream out, String comments) method and suppresses IOExceptions that were thrown.

setProperty

open fun setProperty(
    key: String!, 
    value: String!
): Any!

Calls the Hashtable method put. Provided for parallelism with the getProperty method. Enforces use of strings for property keys and values. The value returned is the result of the Hashtable call to put.

store

open fun store(
    writer: Writer!, 
    comments: String!
): Unit

Writes this property list (key and element pairs) in this Properties table to the output character stream in a format suitable for using the load(Reader) method.

Properties from the defaults table of this Properties table (if any) are not written out by this method.

If the comments argument is not null, then an ASCII character, the comments string, and a line separator are first written to the output stream. Thus, the comments can serve as an identifying comment. Any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a line feed in comments is replaced by a line separator generated by the Writer and if the next character in comments is not character or character ! then an ASCII is written out after that line separator.

Next, a comment line is always written, consisting of an ASCII character, the current date and time (as if produced by the toString method of Date for the current time), and a line separator as generated by the Writer.

Then every entry in this Properties table is written out, one per line. For each entry the key string is written, then an ASCII =, then the associated element string. For the key, all space characters are written with a preceding \ character. For the element, leading space characters, but not embedded or trailing space characters, are written with a preceding \ character. The key and element characters , !, =, and : are written with a preceding backslash to ensure that they are properly loaded.

After the entries have been written, the output stream is flushed. The output stream remains open after this method returns.

store

open fun store(
    out: OutputStream!, 
    comments: String!
): Unit

Writes this property list (key and element pairs) in this Properties table to the output stream in a format suitable for loading into a Properties table using the load(InputStream) method.

Properties from the defaults table of this Properties table (if any) are not written out by this method.

This method outputs the comments, properties keys and values in the same format as specified in store(Writer), with the following differences:

• The stream is written using the ISO 8859-1 character encoding.
• Characters not in Latin-1 in the comments are written as \u005Cuxxxx for their appropriate unicode hexadecimal value xxxx.
• Characters less than \u005Cu0020 and characters greater than \u005Cu007E in property keys or values are written as \u005Cuxxxx for the appropriate hexadecimal value xxxx.

After the entries have been written, the output stream is flushed. The output stream remains open after this method returns.

storeToXML

open fun storeToXML(
    os: OutputStream!, 
    comment: String!
): Unit

Emits an XML document representing all of the properties contained in this table.

An invocation of this method of the form props.storeToXML(os, comment) behaves in exactly the same way as the invocation props.storeToXML(os, comment, "UTF-8");.

storeToXML

open fun storeToXML(
    os: OutputStream!, 
    comment: String!, 
    encoding: String!
): Unit

Emits an XML document representing all of the properties contained in this table, using the specified encoding.

The XML document will have the following DOCTYPE declaration:

<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
  

If the specified comment is null then no comment will be stored in the document.

An implementation is required to support writing of XML documents that use the "UTF-8" or "UTF-16" encoding. An implementation may support additional encodings.

The specified stream remains open after this method returns.

This method behaves the same as storeToXML(java.io.OutputStream,java.lang.String,java.nio.charset.Charset) except that it will look up the charset using the given encoding name.

stringPropertyNames

open fun stringPropertyNames(): MutableSet<String!>!

Returns an unmodifiable set of keys from this property list where the key and its corresponding value are strings, including distinct keys in the default property list if a key of the same name has not already been found from the main properties list. Properties whose key or value is not of type String are omitted.

The returned set is not backed by this Properties object. Changes to this Properties object are not reflected in the returned set.

toString

open fun toString(): String

rehash

protected open fun rehash(): Unit

defaults

protected var defaults: Properties!

A property list that contains default values for any keys not found in this property list.

entries

open val entries: MutableSet<MutableEntry<Any!, Any!>>

keys

open val keys: MutableSet<Any!>

size

open val size: Int

values

open val values: MutableCollection<Any!>