EditableProperties (Base Utilities API)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.String>
- - org.openide.util.EditableProperties

All Implemented Interfaces:

java.lang.Cloneable
```
public final class EditableProperties
extends java.util.AbstractMap<java.lang.String,java.lang.String>
implements java.lang.Cloneable
```
Similar to Properties but designed to retain additional information needed for safe hand-editing. Useful for various *.properties in a project:
1. Can associate comments with particular entries.
2. Order of entries preserved during modifications whenever possible.
3. VCS-friendly: lines which are not semantically modified are not textually modified.
4. Can automatically insert line breaks in new or modified values at positions that are likely to be semantically meaningful, e.g. between path components
The file format (including encoding etc.) is compatible with the regular JRE implementation. Only (non-null) String is supported for keys and values. This class is not thread-safe; use only from a single thread, or use Collections.synchronizedMap(java.util.Map<K, V>).
Since:

org.openide.util 7.26

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,V extends java.lang.Object>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Constructor Summary

Constructors
Constructor Description

EditableProperties(boolean alphabetize)
Creates empty instance.

Constructors
Constructor	Description
`EditableProperties(boolean alphabetize)`	Creates empty instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Object`	`clone()`
`EditableProperties`	`cloneProperties()`	Create an exact copy of this properties object.
`java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>`	`entrySet()`	Returns a set view of the mappings ordered according to their file position.
`java.lang.String`	`get(java.lang.Object key)`
`java.lang.String[]`	`getComment(java.lang.String key)`	Returns comment associated with the property.
`java.lang.String`	`getProperty(java.lang.String key)`	Convenience method to get a property as a string.
`void`	`load(java.io.InputStream stream)`	Load properties from a stream.
`java.lang.String`	`put(java.lang.String key, java.lang.String value)`
`void`	`setComment(java.lang.String key, java.lang.String[] comment, boolean separate)`	Create comment for the property.
`java.lang.String`	`setProperty(java.lang.String key, java.lang.String value)`	Convenience method to set a property.
`java.lang.String`	`setProperty(java.lang.String key, java.lang.String[] value)`	Sets a property to a value broken into segments for readability.
`void`	`store(java.io.OutputStream stream)`	Store properties to a stream.

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, putAll, remove, size, toString, values

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, entry, forEach, getOrDefault, merge, of, of, of, of, of, of, of, of, of, of, of, ofEntries, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EditableProperties
```
public EditableProperties(boolean alphabetize)
```
    Creates empty instance.
    
    Parameters:
    
    alphabetize - alphabetize new items according to key or not
- Method Detail
  - entrySet
```
public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> entrySet()
```
    Returns a set view of the mappings ordered according to their file position. Each element in this set is a Map.Entry. See AbstractMap.entrySet() for more details.
    
    Specified by:
    
    entrySet in class java.util.AbstractMap<java.lang.String,java.lang.String>
    
    Returns:
    
    set with Map.Entry instances.
  - load
```
public void load(java.io.InputStream stream)
          throws java.io.IOException
```
    Load properties from a stream.
    
    Parameters:
    
    stream - an input stream
    
    Throws:
    
    java.io.IOException - if the contents are malformed or the stream could not be read
  - store
```
public void store(java.io.OutputStream stream)
           throws java.io.IOException
```
    Store properties to a stream.
    
    Parameters:
    
    stream - an output stream
    
    Throws:
    
    java.io.IOException - if the stream could not be written to
  - get
```
public java.lang.String get(java.lang.Object key)
```
    Overrides:
    
    get in class java.util.AbstractMap<java.lang.String,java.lang.String>
  - put
```
public java.lang.String put(java.lang.String key,
                            java.lang.String value)
```
    Overrides:
    
    put in class java.util.AbstractMap<java.lang.String,java.lang.String>
  - getProperty
```
public java.lang.String getProperty(java.lang.String key)
```
    Convenience method to get a property as a string. Same as get(java.lang.Object); only here because of pre-generic code.
    
    Parameters:
    
    key - a property name; cannot be null nor empty
    
    Returns:
    
    the property value, or null if it was not defined
  - setProperty
```
public java.lang.String setProperty(java.lang.String key,
                                    java.lang.String value)
```
    Convenience method to set a property. Same as put(java.lang.String, java.lang.String); only here because of pre-generic code.
    
    Parameters:
    
    key - a property name; cannot be null nor empty
    
    value - the desired value; cannot be null
    
    Returns:
    
    previous value of the property or null if there was not any
  - setProperty
```
public java.lang.String setProperty(java.lang.String key,
                                    java.lang.String[] value)
```
    Sets a property to a value broken into segments for readability. Same behavior as setProperty(String,String) with the difference that each item will be stored on its own line of text. getProperty(java.lang.String) will simply concatenate all the items into one string, so generally separators (such as : for path-like properties) must be included in the items (for example, at the end of all but the last item).
    
    Parameters:
    
    key - a property name; cannot be null nor empty
    
    value - the desired value; cannot be null; can be empty array
    
    Returns:
    
    previous value of the property or null if there was not any
  - getComment
```
public java.lang.String[] getComment(java.lang.String key)
```
    Returns comment associated with the property. The comment lines are returned as defined in properties file, that is comment delimiter is included. Comment for property is defined as: continuous block of lines starting with comment delimiter which are followed by property declaration (no empty line separator allowed).
    
    Parameters:
    
    key - a property name; cannot be null nor empty
    
    Returns:
    
    array of String lines as specified in properties file; comment delimiter character is included
  - setComment
```
public void setComment(java.lang.String key,
                       java.lang.String[] comment,
                       boolean separate)
```
    Create comment for the property.
    Note: if a comment includes non-ISO-8859-1 characters, they will be written to disk using Unicode escapes (and getComment(java.lang.String) will interpret such escapes), but of course they will be unreadable for humans.
    
    Parameters:
    
    key - a property name; cannot be null nor empty
    
    comment - lines of comment which will be written just above the property; no reformatting; comment lines must start with comment delimiter; cannot be null; cannot be emty array
    
    separate - whether the comment should be separated from previous item by empty line
  - clone
```
public java.lang.Object clone()
```
    Overrides:
    
    clone in class java.util.AbstractMap<java.lang.String,java.lang.String>
  - cloneProperties
```
public EditableProperties cloneProperties()
```
    Create an exact copy of this properties object.
    
    Returns:
    
    a clone of this object

Class EditableProperties

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractMap

Methods inherited from interface java.util.Map

Methods inherited from class java.lang.Object

Constructor Detail

EditableProperties

Method Detail

entrySet

load

store

get

put

getProperty

setProperty

setProperty

getComment

setComment

clone

cloneProperties