From class Provider
Unit |
clear()
Clears this provider so that it no longer contains the properties used to look up facilities implemented by the provider.
If a security manager is enabled, its checkSecurityAccess method is called with the string "clearProviderProperties."+name (where name is the provider name) to see if it's ok to clear this provider.
|
Any? |
compute(key: Any!, remappingFunction: BiFunction<in Any!, in Any?, *>)
Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping).
If a security manager is enabled, its checkSecurityAccess method is called with the strings "putProviderProperty."+name and "removeProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values and remove this provider's properties.
|
Any! |
computeIfAbsent(key: Any!, mappingFunction: Function<in Any!, *>)
If the specified key is not already associated with a value (or is mapped to null), attempts to compute its value using the given mapping function and enters it into this map unless null.
If a security manager is enabled, its checkSecurityAccess method is called with the strings "putProviderProperty."+name and "removeProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values and remove this provider's properties.
|
Any? |
computeIfPresent(key: Any!, remappingFunction: BiFunction<in Any!, in Any, *>)
If the value for the specified key is present and non-null, attempts to compute a new mapping given the key and its current mapped value.
If a security manager is enabled, its checkSecurityAccess method is called with the strings "putProviderProperty."+name and "removeProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values and remove this provider's properties.
|
Enumeration<Any!>! |
elements()
|
Unit |
forEach(action: BiConsumer<in Any!, in Any!>)
|
Any? |
get(key: Any!)
|
String! |
getInfo()
Returns a human-readable description of the provider and its services. This may return an HTML page, with relevant links.
|
String! |
getName()
Returns the name of this provider.
|
Any! |
getOrDefault(key: Any!, defaultValue: Any!)
|
String! |
getProperty(key: String!)
|
Provider.Service! |
getService(type: String!, algorithm: String!)
Get the service describing this Provider's implementation of the specified type of this algorithm or alias. If no such implementation exists, this method returns null. If there are two matching services, one added to this provider using putService() and one added via #put, the service added via putService() is returned.
|
MutableSet<Provider.Service!>! |
getServices()
Get an unmodifiable Set of all services supported by this Provider.
|
Double |
getVersion()
Returns the version number for this provider.
|
Enumeration<Any!>! |
keys()
|
Unit |
load(inStream: InputStream!)
Reads a property list (key and element pairs) from the input stream.
|
Any? |
merge(key: Any!, value: Any, remappingFunction: BiFunction<in Any, in Any, *>)
If the specified key is not already associated with a value or is associated with null, associates it with the given value. Otherwise, replaces the value with the results of the given remapping function, or removes if the result is null. This method may be of use when combining multiple mapped values for a key.
If a security manager is enabled, its checkSecurityAccess method is called with the strings "putProviderProperty."+name and "removeProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values and remove this provider's properties.
|
Any? |
put(key: Any!, value: Any!)
Sets the key property to have the specified value.
If a security manager is enabled, its checkSecurityAccess method is called with the string "putProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values.
|
Unit |
putAll(from: Map<*, *>)
Copies all of the mappings from the specified Map to this provider. These mappings will replace any properties that this provider had for any of the keys currently in the specified Map.
|
Any? |
putIfAbsent(key: Any!, value: Any!)
If the specified key is not already associated with a value (or is mapped to null) associates it with the given value and returns null, else returns the current value.
If a security manager is enabled, its checkSecurityAccess method is called with the string "putProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values.
|
Unit |
putService(s: Provider.Service!)
Add a service. If a service of the same type with the same algorithm name exists and it was added using putService(), it is replaced by the new service. This method also places information about this service in the provider's Hashtable values in the format described in the Java Cryptography Architecture API Specification & Reference .
Also, if there is a security manager, its checkSecurityAccess method is called with the string "putProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values. If the default implementation of checkSecurityAccess is used (that is, that method is not overriden), then this results in a call to the security manager's checkPermission method with a SecurityPermission("putProviderProperty."+name) permission.
|
Any? |
remove(key: Any!)
Removes the key property (and its corresponding value).
If a security manager is enabled, its checkSecurityAccess method is called with the string "removeProviderProperty."+name, where name is the provider name, to see if it's ok to remove this provider's properties.
|
Boolean |
remove(key: Any!, value: Any!)
Removes the entry for the specified key only if it is currently mapped to the specified value.
If a security manager is enabled, its checkSecurityAccess method is called with the string "removeProviderProperty."+name, where name is the provider name, to see if it's ok to remove this provider's properties.
|
Unit |
removeService(s: Provider.Service!)
Remove a service previously added using putService(). The specified service is removed from this provider. It will no longer be returned by getService() and its information will be removed from this provider's Hashtable.
Also, if there is a security manager, its checkSecurityAccess method is called with the string "removeProviderProperty."+name, where name is the provider name, to see if it's ok to remove this provider's properties. If the default implementation of checkSecurityAccess is used (that is, that method is not overriden), then this results in a call to the security manager's checkPermission method with a SecurityPermission("removeProviderProperty."+name) permission.
|
Boolean |
replace(key: Any!, oldValue: Any!, newValue: Any!)
Replaces the entry for the specified key only if currently mapped to the specified value.
If a security manager is enabled, its checkSecurityAccess method is called with the string "putProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values.
|
Any? |
replace(key: Any!, value: Any!)
Replaces the entry for the specified key only if it is currently mapped to some value.
If a security manager is enabled, its checkSecurityAccess method is called with the string "putProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values.
|
Unit |
replaceAll(function: BiFunction<in Any!, in Any!, *>)
Replaces each entry's value with the result of invoking the given function on that entry, in the order entries are returned by an entry set iterator, until all entries have been processed or the function throws an exception.
If a security manager is enabled, its checkSecurityAccess method is called with the string "putProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values.
|
String |
toString()
Returns a string with the name and the version number of this provider.
|
|
From class Properties
Any |
clone()
|
Boolean |
contains(value: Any!)
|
Boolean |
containsKey(key: Any!)
|
Boolean |
containsValue(value: Any!)
|
Boolean |
equals(other: Any?)
|
String! |
getProperty(key: String!, defaultValue: 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.
|
Int |
hashCode()
|
Boolean |
isEmpty()
|
Unit |
list(out: PrintStream!)
Prints this property list out to the specified output stream. This method is useful for debugging.
|
Unit |
list(out: PrintWriter!)
Prints this property list out to the specified output stream. This method is useful for debugging.
|
Unit |
load(reader: Reader!)
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
As another example, the following three lines specify a single property:
fruits apple, banana, pear, \
cantaloupe, watermelon, \
kiwi, mango
The key is "fruits" and the associated element is:
"apple, banana, pear, cantaloupe, watermelon, kiwi, mango"
Note that a space appears before each \ so that a space will appear after each comma in the final result; the \, line terminator, and leading white space on the continuation line are merely discarded and are not replaced by one or more other characters.
As a third example, the line:
cheeses
specifies that the key is "cheeses" and the associated element is the empty string "".
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.
|
Unit |
loadFromXML(in: InputStream!)
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">
Furthermore, the document must satisfy the properties DTD described above.
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.
|
Enumeration<*>! |
propertyNames()
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.
|
Unit |
rehash()
|
Unit |
save(out: OutputStream!, : String!)
Calls the store(OutputStream out, String comments) method and suppresses IOExceptions that were thrown.
|
Any! |
setProperty(key: String!, value: String!)
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.
|
Unit |
store(writer: Writer!, : String!)
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 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 ! then an ASCII
Next, a comment line is always written, consisting of an ASCII 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.
|
Unit |
store(out: OutputStream!, : String!)
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.
|
Unit |
storeToXML(os: OutputStream!, : String!)
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");.
|
Unit |
storeToXML(os: OutputStream!, : String!, encoding: String!)
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.
|
Unit |
storeToXML(os: OutputStream!, : String!, charset: Charset!)
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.
Unmappable characters for the specified charset will be encoded as numeric character references.
The specified stream remains open after this method returns.
|
MutableSet<String!>! |
stringPropertyNames()
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.
|
|
