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