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