java/sql-dk/src/info/globalcode/sql/dk/configuration/Properties.java
author František Kučera <franta-hg@frantovo.cz>
Fri, 10 Jan 2014 23:21:28 +0100
branchv_0
changeset 155 eb3676c6929b
parent 133 a1bf1465df89
child 191 862d0a8747ac
permissions -rw-r--r--
more JavaDoc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
104
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     1
/**
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     2
 * SQL-DK
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     3
 * Copyright © 2013 František Kučera (frantovo.cz)
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     4
 *
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     5
 * This program is free software: you can redistribute it and/or modify
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License as published by
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     7
 * the Free Software Foundation, either version 3 of the License, or
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     8
 * (at your option) any later version.
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     9
 *
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    10
 * This program is distributed in the hope that it will be useful,
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    13
 * GNU General Public License for more details.
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    14
 *
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    16
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    17
 */
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    18
package info.globalcode.sql.dk.configuration;
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    19
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    20
import java.util.ArrayList;
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    21
import javax.xml.bind.annotation.XmlTransient;
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    22
import static info.globalcode.sql.dk.Functions.findByName;
105
39d8b427e20f cloneable property and properties
František Kučera <franta-hg@frantovo.cz>
parents: 104
diff changeset
    23
import java.util.Collections;
104
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    24
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    25
/**
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    26
 * <p>List of configurables.</p>
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    27
 *
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    28
 * <p>Can be backed by defaults – if value for given name is nof found in this instance, we will
155
eb3676c6929b more JavaDoc
František Kučera <franta-hg@frantovo.cz>
parents: 133
diff changeset
    29
 * look into defaults. Methods also accept defaultValue parameter – is used if property is nof found
eb3676c6929b more JavaDoc
František Kučera <franta-hg@frantovo.cz>
parents: 133
diff changeset
    30
 * even in default properties.</p>
104
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    31
 *
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    32
 * <p>Typical use: </p>
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    33
 * <ul>
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    34
 * <li>this instance – ad-hoc properties from CLI options</li>
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    35
 * <li>default properties – from config file</li>
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    36
 * <li>defaultValue – hardcoded default</li>
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    37
 * </ul>
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    38
 *
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    39
 * @author Ing. František Kučera (frantovo.cz)
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    40
 */
105
39d8b427e20f cloneable property and properties
František Kučera <franta-hg@frantovo.cz>
parents: 104
diff changeset
    41
public class Properties extends ArrayList<Property> implements Cloneable {
104
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    42
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    43
	private Properties defaults;
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    44
105
39d8b427e20f cloneable property and properties
František Kučera <franta-hg@frantovo.cz>
parents: 104
diff changeset
    45
	public Properties() {
39d8b427e20f cloneable property and properties
František Kučera <franta-hg@frantovo.cz>
parents: 104
diff changeset
    46
	}
39d8b427e20f cloneable property and properties
František Kučera <franta-hg@frantovo.cz>
parents: 104
diff changeset
    47
39d8b427e20f cloneable property and properties
František Kučera <franta-hg@frantovo.cz>
parents: 104
diff changeset
    48
	public Properties(int initialCapacity) {
39d8b427e20f cloneable property and properties
František Kučera <franta-hg@frantovo.cz>
parents: 104
diff changeset
    49
		super(initialCapacity);
39d8b427e20f cloneable property and properties
František Kučera <franta-hg@frantovo.cz>
parents: 104
diff changeset
    50
	}
39d8b427e20f cloneable property and properties
František Kučera <franta-hg@frantovo.cz>
parents: 104
diff changeset
    51
104
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    52
	@XmlTransient
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    53
	public Properties getDefaults() {
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    54
		return defaults;
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    55
	}
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    56
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    57
	public void setDefaults(Properties defaults) {
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    58
		this.defaults = defaults;
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    59
	}
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    60
133
a1bf1465df89 Properties: setLastDefaults()
František Kučera <franta-hg@frantovo.cz>
parents: 108
diff changeset
    61
	/**
a1bf1465df89 Properties: setLastDefaults()
František Kučera <franta-hg@frantovo.cz>
parents: 108
diff changeset
    62
	 * @param defaults the last/deepest defaults
a1bf1465df89 Properties: setLastDefaults()
František Kučera <franta-hg@frantovo.cz>
parents: 108
diff changeset
    63
	 */
a1bf1465df89 Properties: setLastDefaults()
František Kučera <franta-hg@frantovo.cz>
parents: 108
diff changeset
    64
	public void setLastDefaults(Properties defaults) {
a1bf1465df89 Properties: setLastDefaults()
František Kučera <franta-hg@frantovo.cz>
parents: 108
diff changeset
    65
		if (this.defaults == null) {
a1bf1465df89 Properties: setLastDefaults()
František Kučera <franta-hg@frantovo.cz>
parents: 108
diff changeset
    66
			this.defaults = defaults;
a1bf1465df89 Properties: setLastDefaults()
František Kučera <franta-hg@frantovo.cz>
parents: 108
diff changeset
    67
		} else {
a1bf1465df89 Properties: setLastDefaults()
František Kučera <franta-hg@frantovo.cz>
parents: 108
diff changeset
    68
			this.defaults.setLastDefaults(defaults);
a1bf1465df89 Properties: setLastDefaults()
František Kučera <franta-hg@frantovo.cz>
parents: 108
diff changeset
    69
		}
a1bf1465df89 Properties: setLastDefaults()
František Kučera <franta-hg@frantovo.cz>
parents: 108
diff changeset
    70
	}
a1bf1465df89 Properties: setLastDefaults()
František Kučera <franta-hg@frantovo.cz>
parents: 108
diff changeset
    71
104
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    72
	private Property findProperty(String name) {
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    73
		Property p = findByName(this, name);
133
a1bf1465df89 Properties: setLastDefaults()
František Kučera <franta-hg@frantovo.cz>
parents: 108
diff changeset
    74
		if (p == null && defaults != null) {
a1bf1465df89 Properties: setLastDefaults()
František Kučera <franta-hg@frantovo.cz>
parents: 108
diff changeset
    75
			p = defaults.findProperty(name);
104
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    76
		}
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    77
		return p;
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    78
	}
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    79
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    80
	public String getString(String name, String defaultValue) {
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    81
		Property p = findProperty(name);
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    82
		return p == null ? defaultValue : p.getValue();
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    83
	}
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    84
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    85
	public boolean getBoolean(String name, boolean defaultValue) {
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    86
		Property p = findProperty(name);
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    87
		return p == null ? defaultValue : Boolean.valueOf(p.getValue());
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    88
	}
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    89
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    90
	public int getInteger(String name, int defaultValue) {
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    91
		Property p = findProperty(name);
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    92
		return p == null ? defaultValue : Integer.valueOf(p.getValue());
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    93
	}
105
39d8b427e20f cloneable property and properties
František Kučera <franta-hg@frantovo.cz>
parents: 104
diff changeset
    94
108
d06d90b28217 DB credentials can be CLI options + log warning: insecure
František Kučera <franta-hg@frantovo.cz>
parents: 107
diff changeset
    95
	public boolean hasProperty(String name) {
d06d90b28217 DB credentials can be CLI options + log warning: insecure
František Kučera <franta-hg@frantovo.cz>
parents: 107
diff changeset
    96
		return findByName(this, name) != null;
d06d90b28217 DB credentials can be CLI options + log warning: insecure
František Kučera <franta-hg@frantovo.cz>
parents: 107
diff changeset
    97
	}
d06d90b28217 DB credentials can be CLI options + log warning: insecure
František Kučera <franta-hg@frantovo.cz>
parents: 107
diff changeset
    98
105
39d8b427e20f cloneable property and properties
František Kučera <franta-hg@frantovo.cz>
parents: 104
diff changeset
    99
	@Override
39d8b427e20f cloneable property and properties
František Kučera <franta-hg@frantovo.cz>
parents: 104
diff changeset
   100
	public Properties clone() {
39d8b427e20f cloneable property and properties
František Kučera <franta-hg@frantovo.cz>
parents: 104
diff changeset
   101
		Properties clone = new Properties(size());
39d8b427e20f cloneable property and properties
František Kučera <franta-hg@frantovo.cz>
parents: 104
diff changeset
   102
		Collections.copy(clone, this);
39d8b427e20f cloneable property and properties
František Kučera <franta-hg@frantovo.cz>
parents: 104
diff changeset
   103
		return clone;
39d8b427e20f cloneable property and properties
František Kučera <franta-hg@frantovo.cz>
parents: 104
diff changeset
   104
	}
106
e9c3583580c8 use database properties
František Kučera <franta-hg@frantovo.cz>
parents: 105
diff changeset
   105
e9c3583580c8 use database properties
František Kučera <franta-hg@frantovo.cz>
parents: 105
diff changeset
   106
	/**
e9c3583580c8 use database properties
František Kučera <franta-hg@frantovo.cz>
parents: 105
diff changeset
   107
	 * @return merged this and backing defaults as Java Properties
e9c3583580c8 use database properties
František Kučera <franta-hg@frantovo.cz>
parents: 105
diff changeset
   108
	 */
e9c3583580c8 use database properties
František Kučera <franta-hg@frantovo.cz>
parents: 105
diff changeset
   109
	public java.util.Properties getJavaProperties() {
e9c3583580c8 use database properties
František Kučera <franta-hg@frantovo.cz>
parents: 105
diff changeset
   110
		java.util.Properties javaProperties = new java.util.Properties();
e9c3583580c8 use database properties
František Kučera <franta-hg@frantovo.cz>
parents: 105
diff changeset
   111
		duplicateTo(javaProperties);
e9c3583580c8 use database properties
František Kučera <franta-hg@frantovo.cz>
parents: 105
diff changeset
   112
		return javaProperties;
e9c3583580c8 use database properties
František Kučera <franta-hg@frantovo.cz>
parents: 105
diff changeset
   113
	}
e9c3583580c8 use database properties
František Kučera <franta-hg@frantovo.cz>
parents: 105
diff changeset
   114
e9c3583580c8 use database properties
František Kučera <franta-hg@frantovo.cz>
parents: 105
diff changeset
   115
	private void duplicateTo(java.util.Properties javaProperties) {
107
8189a4a28cd8 database/formatter properties also as CLI options
František Kučera <franta-hg@frantovo.cz>
parents: 106
diff changeset
   116
		if (defaults != null) {
8189a4a28cd8 database/formatter properties also as CLI options
František Kučera <franta-hg@frantovo.cz>
parents: 106
diff changeset
   117
			defaults.duplicateTo(javaProperties);
8189a4a28cd8 database/formatter properties also as CLI options
František Kučera <franta-hg@frantovo.cz>
parents: 106
diff changeset
   118
		}
106
e9c3583580c8 use database properties
František Kučera <franta-hg@frantovo.cz>
parents: 105
diff changeset
   119
		for (Property p : this) {
e9c3583580c8 use database properties
František Kučera <franta-hg@frantovo.cz>
parents: 105
diff changeset
   120
			javaProperties.setProperty(p.getName(), p.getValue());
e9c3583580c8 use database properties
František Kučera <franta-hg@frantovo.cz>
parents: 105
diff changeset
   121
		}
e9c3583580c8 use database properties
František Kučera <franta-hg@frantovo.cz>
parents: 105
diff changeset
   122
	}
104
245f1b88a3e6 formatter/database properties
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
   123
}