PropertiesParser.java
/*
* All content copyright Terracotta, Inc., unless otherwise indicated. All rights reserved.
* Copyright IBM Corp. 2024, 2025
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy
* of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
*/
package org.quartz.utils;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.Properties;
import java.util.StringTokenizer;
/**
* <p>
* This is an utility class used to parse the properties.
* </p>
*
* @author James House
*/
public class PropertiesParser {
/*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Data members.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
Properties props;
/*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Constructors.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
public PropertiesParser(Properties props) {
this.props = props;
}
/*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Interface.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
public Properties getUnderlyingProperties() {
return props;
}
/**
* Get the trimmed String value of the property with the given
* <code>name</code>. If the value the empty String (after
* trimming), then it returns null.
*/
public String getStringProperty(String name) {
return getStringProperty(name, null);
}
/**
* Get the trimmed String value of the property with the given
* <code>name</code> or the given default value if the value is
* null or empty after trimming.
*/
public String getStringProperty(String name, String def) {
String val = props.getProperty(name, def);
if (val == null) {
return def;
}
val = val.trim();
return (val.isEmpty()) ? def : val;
}
public String[] getStringArrayProperty(String name) {
return getStringArrayProperty(name, null);
}
public String[] getStringArrayProperty(String name, String[] def) {
String vals = getStringProperty(name);
if (vals == null) {
return def;
}
StringTokenizer stok = new StringTokenizer(vals, ",");
ArrayList<String> strs = new ArrayList<>();
try {
while (stok.hasMoreTokens()) {
strs.add(stok.nextToken().trim());
}
return (String[])strs.toArray(new String[strs.size()]);
} catch (Exception e) {
return def;
}
}
public boolean getBooleanProperty(String name) {
return getBooleanProperty(name, false);
}
public boolean getBooleanProperty(String name, boolean def) {
String val = getStringProperty(name);
return (val == null) ? def : Boolean.parseBoolean(val);
}
public byte getByteProperty(String name) throws NumberFormatException {
String val = getStringProperty(name);
if (val == null) {
throw new NumberFormatException(" null string");
}
try {
return Byte.parseByte(val);
} catch (NumberFormatException nfe) {
throw new NumberFormatException(" '" + val + "'");
}
}
public byte getByteProperty(String name, byte def)
throws NumberFormatException {
String val = getStringProperty(name);
if (val == null) {
return def;
}
try {
return Byte.parseByte(val);
} catch (NumberFormatException nfe) {
throw new NumberFormatException(" '" + val + "'");
}
}
public char getCharProperty(String name) {
return getCharProperty(name, '\0');
}
public char getCharProperty(String name, char def) {
String param = getStringProperty(name);
return (param == null) ? def : param.charAt(0);
}
public double getDoubleProperty(String name) throws NumberFormatException {
String val = getStringProperty(name);
if (val == null) {
throw new NumberFormatException(" null string");
}
try {
return Double.parseDouble(val);
} catch (NumberFormatException nfe) {
throw new NumberFormatException(" '" + val + "'");
}
}
public double getDoubleProperty(String name, double def)
throws NumberFormatException {
String val = getStringProperty(name);
if (val == null) {
return def;
}
try {
return Double.parseDouble(val);
} catch (NumberFormatException nfe) {
throw new NumberFormatException(" '" + val + "'");
}
}
public float getFloatProperty(String name) throws NumberFormatException {
String val = getStringProperty(name);
if (val == null) {
throw new NumberFormatException(" null string");
}
try {
return Float.parseFloat(val);
} catch (NumberFormatException nfe) {
throw new NumberFormatException(" '" + val + "'");
}
}
public float getFloatProperty(String name, float def)
throws NumberFormatException {
String val = getStringProperty(name);
if (val == null) {
return def;
}
try {
return Float.parseFloat(val);
} catch (NumberFormatException nfe) {
throw new NumberFormatException(" '" + val + "'");
}
}
public int getIntProperty(String name) throws NumberFormatException {
String val = getStringProperty(name);
if (val == null) {
throw new NumberFormatException(" null string");
}
try {
return Integer.parseInt(val);
} catch (NumberFormatException nfe) {
throw new NumberFormatException(" '" + val + "'");
}
}
public int getIntProperty(String name, int def)
throws NumberFormatException {
String val = getStringProperty(name);
if (val == null) {
return def;
}
try {
return Integer.parseInt(val);
} catch (NumberFormatException nfe) {
throw new NumberFormatException(" '" + val + "'");
}
}
public int[] getIntArrayProperty(String name) throws NumberFormatException {
return getIntArrayProperty(name, null);
}
public int[] getIntArrayProperty(String name, int[] def)
throws NumberFormatException {
String vals = getStringProperty(name);
if (vals == null) {
return def;
}
StringTokenizer stok = new StringTokenizer(vals, ",");
ArrayList<Integer> ints = new ArrayList<>();
try {
while (stok.hasMoreTokens()) {
try {
ints.add(Integer.valueOf(stok.nextToken().trim()));
} catch (NumberFormatException nfe) {
throw new NumberFormatException(" '" + vals + "'");
}
}
int[] outInts = new int[ints.size()];
for (int i = 0; i < ints.size(); i++) {
outInts[i] = ints.get(i);
}
return outInts;
} catch (Exception e) {
return def;
}
}
public long getLongProperty(String name) throws NumberFormatException {
String val = getStringProperty(name);
if (val == null) {
throw new NumberFormatException(" null string");
}
try {
return Long.parseLong(val);
} catch (NumberFormatException nfe) {
throw new NumberFormatException(" '" + val + "'");
}
}
public long getLongProperty(String name, long def)
throws NumberFormatException {
String val = getStringProperty(name);
if (val == null) {
return def;
}
try {
return Long.parseLong(val);
} catch (NumberFormatException nfe) {
throw new NumberFormatException(" '" + val + "'");
}
}
public short getShortProperty(String name) throws NumberFormatException {
String val = getStringProperty(name);
if (val == null) {
throw new NumberFormatException(" null string");
}
try {
return Short.parseShort(val);
} catch (NumberFormatException nfe) {
throw new NumberFormatException(" '" + val + "'");
}
}
public short getShortProperty(String name, short def)
throws NumberFormatException {
String val = getStringProperty(name);
if (val == null) {
return def;
}
try {
return Short.parseShort(val);
} catch (NumberFormatException nfe) {
throw new NumberFormatException(" '" + val + "'");
}
}
public String[] getPropertyGroups(String prefix) {
Enumeration<?> keys = props.propertyNames();
HashSet<String> groups = new HashSet<>(10);
if (!prefix.endsWith(".")) {
prefix += ".";
}
while (keys.hasMoreElements()) {
String key = (String) keys.nextElement();
if (key.startsWith(prefix)) {
String groupName = key.substring(prefix.length(), key.indexOf(
'.', prefix.length()));
groups.add(groupName);
}
}
return (String[]) groups.toArray(new String[groups.size()]);
}
public Properties getPropertyGroup(String prefix) {
return getPropertyGroup(prefix, false, null);
}
public Properties getPropertyGroup(String prefix, boolean stripPrefix) {
return getPropertyGroup(prefix, stripPrefix, null);
}
/**
* Get all properties that start with the given prefix.
*
* @param prefix The prefix for which to search. If it does not end in
* a "." then one will be added to it for search purposes.
* @param stripPrefix Whether to strip off the given <code>prefix</code>
* in the result's keys.
* @param excludedPrefixes Optional array of fully qualified prefixes to
* exclude. For example if <code>prefix</code> is "a.b.c", then
* <code>excludedPrefixes</code> might be "a.b.c.ignore".
*
* @return Group of <code>Properties</code> that start with the given prefix,
* optionally have that prefix removed, and do not include properties
* that start with one of the given excluded prefixes.
*/
public Properties getPropertyGroup(String prefix, boolean stripPrefix, String[] excludedPrefixes) {
Enumeration<?> keys = props.propertyNames();
Properties group = new Properties();
if (!prefix.endsWith(".")) {
prefix += ".";
}
while (keys.hasMoreElements()) {
String key = (String) keys.nextElement();
if (key.startsWith(prefix)) {
boolean exclude = false;
if (excludedPrefixes != null) {
for (int i = 0; (i < excludedPrefixes.length) && (!exclude); i++) {
exclude = key.startsWith(excludedPrefixes[i]);
}
}
if (!exclude) {
String value = getStringProperty(key, "");
if (stripPrefix) {
group.put(key.substring(prefix.length()), value);
} else {
group.put(key, value);
}
}
}
}
return group;
}
}