OrderedProperties (easycode-common 0.2.4 API)

java.lang.Object
- com.easycodebox.common.file.OrderedProperties

所有已实现的接口:

Serializable
```
public final class OrderedProperties
extends Object
implements Serializable
```
有序Properties，与java.util.Properties不同，此类是非线程安全。官网地址：https://github.com/etiennestuder/java-ordered-properties This class provides an alternative to the JDK's Properties class. It fixes the design flaw of using inheritance over composition, while keeping up the same APIs as the original class. Keys and values are guaranteed to be of type String.
This class is not synchronized, contrary to the original implementation.
As additional functionality, this class keeps its properties in a well-defined order. By default, the order is the one in which the individual properties have been added, either through explicit API calls or through reading them top-to-bottom from a properties file.
Also, an optional flag can be set to omit the comment that contains the current date when storing the properties to a properties file.
Currently, this class does not support the concept of default properties, contrary to the original implementation.
Note that this implementation is not synchronized. If multiple threads access ordered properties concurrently, and at least one of the threads modifies the ordered properties structurally, it must be synchronized externally. This is typically accomplished by synchronizing on some object that naturally encapsulates the properties.
Note that the actual (and quite complex) logic of parsing and storing properties from and to a stream is delegated to the Properties class from the JDK.

另请参阅:

Properties, 序列化表格

嵌套类概要

嵌套类
限定符和类型类和说明

static class OrderedProperties.OrderedPropertiesBuilder
Builder for OrderedProperties instances.

嵌套类
限定符和类型	类和说明
`static class`	`OrderedProperties.OrderedPropertiesBuilder` Builder for `OrderedProperties` instances.

构造器概要

构造器
构造器和说明

OrderedProperties()
Creates a new instance that will keep the properties in the order they have been added.

构造器
构造器和说明
`OrderedProperties()` Creates a new instance that will keep the properties in the order they have been added.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`containsProperty(String key)` Returns `true` if there is a property with the specified key.
`static OrderedProperties`	`copyOf(OrderedProperties source)` Creates a new instance that will have both the same property entries and the same behavior as the given source.
`Set<Map.Entry<String,String>>`	`entrySet()` See `Hashtable.entrySet()`.
`boolean`	`equals(Object other)`
`String`	`getProperty(String key)` See `Properties.getProperty(String)`.
`String`	`getProperty(String key, String defaultValue)` See `Properties.getProperty(String, String)`.
`int`	`hashCode()`
`boolean`	`isEmpty()` See `Hashtable.isEmpty()`.
`void`	`list(PrintStream stream)` See `Properties.list(PrintStream)`.
`void`	`list(PrintWriter writer)` See `Properties.list(PrintWriter)`.
`void`	`load(InputStream stream)` See `Properties.load(InputStream)`.
`void`	`load(Reader reader)` See `Properties.load(Reader)`.
`void`	`loadFromXML(InputStream stream)` See `Properties.loadFromXML(InputStream)`.
`Enumeration<String>`	`propertyNames()` See `Properties.propertyNames()`.
`String`	`removeProperty(String key)` Removes the property with the specified key, if it is present.
`String`	`setProperty(String key, String value)` See `Properties.setProperty(String, String)`.
`int`	`size()` See `Hashtable.size()`.
`void`	`store(OutputStream stream, String comments)` See `Properties.store(OutputStream, String)`.
`void`	`store(Writer writer, String comments)` See `Properties.store(Writer, String)`.
`void`	`storeToXML(OutputStream stream, String comment)` See `Properties.storeToXML(OutputStream, String)`.
`void`	`storeToXML(OutputStream stream, String comment, String encoding)` See `Properties.storeToXML(OutputStream, String, String)`.
`Set<String>`	`stringPropertyNames()` See `Properties.stringPropertyNames()`.
`Properties`	`toJdkProperties()` Convert this instance to a `Properties` instance.
`String`	`toString()` See `Hashtable.toString()`.

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - OrderedProperties
```
public OrderedProperties()
```
    Creates a new instance that will keep the properties in the order they have been added. Other than the ordering of the keys, this instance behaves like an instance of the Properties class.
- 方法详细资料
  - getProperty
```
public String getProperty(String key)
```
    See Properties.getProperty(String).
  - getProperty
```
public String getProperty(String key,
                          String defaultValue)
```
    See Properties.getProperty(String, String).
  - setProperty
```
public String setProperty(String key,
                          String value)
```
    See Properties.setProperty(String, String).
  - removeProperty
```
public String removeProperty(String key)
```
    Removes the property with the specified key, if it is present. Returns the value of the property, or null if there was no property with the specified key.
    
    参数:
    
    key - the key of the property to remove
    
    返回:
    
    the previous value of the property, or null if there was no property with the specified key
  - containsProperty
```
public boolean containsProperty(String key)
```
    Returns true if there is a property with the specified key.
    
    参数:
    
    key - the key whose presence is to be tested
  - size
```
public int size()
```
    See Hashtable.size().
  - isEmpty
```
public boolean isEmpty()
```
    See Hashtable.isEmpty().
  - propertyNames
```
public Enumeration<String> propertyNames()
```
    See Properties.propertyNames().
  - stringPropertyNames
```
public Set<String> stringPropertyNames()
```
    See Properties.stringPropertyNames().
  - entrySet
```
public Set<Map.Entry<String,String>> entrySet()
```
    See Hashtable.entrySet().
  - load
```
public void load(InputStream stream)
          throws IOException
```
    See Properties.load(InputStream).
    
    抛出:
    
    IOException
  - load
```
public void load(Reader reader)
          throws IOException
```
    See Properties.load(Reader).
    
    抛出:
    
    IOException
  - loadFromXML
```
public void loadFromXML(InputStream stream)
                 throws IOException,
                        InvalidPropertiesFormatException
```
    See Properties.loadFromXML(InputStream).
    
    抛出:
    
    IOException
    
    InvalidPropertiesFormatException
  - store
```
public void store(OutputStream stream,
                  String comments)
           throws IOException
```
    See Properties.store(OutputStream, String).
    
    抛出:
    
    IOException
  - store
```
public void store(Writer writer,
                  String comments)
           throws IOException
```
    See Properties.store(Writer, String).
    
    抛出:
    
    IOException
  - storeToXML
```
public void storeToXML(OutputStream stream,
                       String comment)
                throws IOException
```
    See Properties.storeToXML(OutputStream, String).
    
    抛出:
    
    IOException
  - storeToXML
```
public void storeToXML(OutputStream stream,
                       String comment,
                       String encoding)
                throws IOException
```
    See Properties.storeToXML(OutputStream, String, String).
    
    抛出:
    
    IOException
  - list
```
public void list(PrintStream stream)
```
    See Properties.list(PrintStream).
  - list
```
public void list(PrintWriter writer)
```
    See Properties.list(PrintWriter).
  - toJdkProperties
```
public Properties toJdkProperties()
```
    Convert this instance to a Properties instance.
    
    返回:
    
    the Properties instance
  - equals
```
public boolean equals(Object other)
```
    覆盖:
    
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object
  - toString
```
public String toString()
```
    See Hashtable.toString().
    
    覆盖:
    
    toString 在类中 Object
  - copyOf
```
public static OrderedProperties copyOf(OrderedProperties source)
```
    Creates a new instance that will have both the same property entries and the same behavior as the given source.
    Note that the source instance and the copy instance will share the same comparator instance if a custom ordering had been configured on the source.
    
    参数:
    
    source - the source to copy from
    
    返回:
    
    the copy

类 OrderedProperties

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

OrderedProperties

方法详细资料

getProperty

getProperty

setProperty

removeProperty

containsProperty

size

isEmpty

propertyNames

stringPropertyNames

entrySet

load

load

loadFromXML

store

store

storeToXML

storeToXML

list

list

toJdkProperties

equals

hashCode

toString

copyOf