webit.script.util.props.Props Maven / Gradle / Ivy
// Copyright (c) 2003-2013, Jodd Team (jodd.org). All Rights Reserved.
package webit.script.util.props;
import java.util.Map;
import webit.script.util.StringUtil;
/**
* Super properties: fast, configurable, supports (ini) sections, profiles.
*
* Basic parsing rules:
*
* - By default, props files are UTF8 encoded.
*
- Leading and trailing spaces will be trimmed from section names and
* property names.
*
- Leading and/or trailing spaces may be trimmed from property values.
*
- You can use either equal sign (=) or colon (:) to assign property values
*
- Comments begin with either a semicolon (;), or a sharp sign (#) and
* extend to the end of line. It doesn't have to be the first character.
*
- A backslash (\) escapes the next character (e.g., \# is a literal #, \\
* is a literal \).
*
- If the last character of a line is backslash (\), the value is continued
* on the next line with new line character included.
*
- \\uXXXX is encoded as character
*
- \t, \r and \f are encoded as characters
*
*
* Sections rules:
*
* - Section names are enclosed between [ and ].
*
- Properties following a section header belong to that section. Section
* name is added as a prefix to section properties.
*
- Section ends with empty section definition [] or with new section start
*
*
* Profiles rules:
*
* - Profile names are enclosed between < and > in property key.
*
- Each property key may contain zero, one or more profile definitions.
*
*
* Macro rules:
*
* - Profile values may contain references to other properties using ${ and }
*
- Inner references are supported
*
- References are resolved first in the profile context and then in the
* base props context.
*
*/
public final class Props /* implements Cloneable */ {
private static final String activeProfilesProp = "@profiles";
private final PropsParser parser;
private final PropsData data;
private String[] activeProfiles;
private volatile boolean initialized;
/**
* Creates new props.
*/
public Props() {
this.data = (this.parser = new PropsParser()).propsData;
}
// protected Props(final PropsParser parser) {
// this.parser = parser;
// this.data = parser.getPropsData();
// }
//
// /**
// * Clones props by creating new instance and copying current configuration.
// */
// @Override
// protected Props clone() {
// final PropsParser parser = this.parser.clone();
// final Props p = new Props(parser);
//
// p.activeProfilesProp = activeProfilesProp;
// return p;
// }
// /**
// * Returns active profiles or
// * null if none defined.
// */
// public String[] getActiveProfiles() {
// initialize();
// return activeProfiles;
// }
//
// // ---------------------------------------------------------------- configuration
// /**
// * Sets new active profiles and overrides existing ones. By setting
// * null, no active profile will be set.
// *
// * Note that if some props file is loaded after
// * this method, it might override this value in the same way.
// */
// public void setActiveProfiles(final String... activeProfiles) {
// initialize();
// this.activeProfiles = activeProfiles;
// }
//
// /**
// * Specifies the new line string when EOL is escaped.
// * Default value is an empty string.
// */
// public void setEscapeNewLineValue(final String escapeNewLineValue) {
// parser.escapeNewLineValue = escapeNewLineValue;
// }
//
// /**
// * Specifies should the values be trimmed from the left.
// * Default is true.
// */
// public void setValueTrimLeft(final boolean valueTrimLeft) {
// parser.valueTrimLeft = valueTrimLeft;
// }
//
// /**
// * Specifies should the values be trimmed from the right.
// * Default is true.
// */
// public void setValueTrimRight(final boolean valueTrimRight) {
// parser.valueTrimRight = valueTrimRight;
// }
//
// /**
// * Defines if the prefix whitespaces should be ignored when value is split into the lines.
// */
// public void setIgnorePrefixWhitespacesOnNewLine(final boolean ignorePrefixWhitespacesOnNewLine) {
// parser.ignorePrefixWhitespacesOnNewLine = ignorePrefixWhitespacesOnNewLine;
// }
//
// /**
// * Skips empty properties as they don't exist.
// */
// public void setSkipEmptyProps(final boolean skipEmptyProps) {
// parser.skipEmptyProps = skipEmptyProps;
// data.skipEmptyProps = skipEmptyProps;
// }
//
// /**
// * Appends duplicate props.
// */
// public void setAppendDuplicateProps(final boolean appendDuplicateProps) {
// data.appendDuplicateProps = appendDuplicateProps;
// }
//
// /**
// * Ignore missing macros by replacing them with an empty string.
// */
// public void setIgnoreMissingMacros(boolean ignoreMissingMacros) {
// data.ignoreMissingMacros = ignoreMissingMacros;
// }
//
// // ---------------------------------------------------------------- load
//
// /**
// * Enables multiline values.
// */
// public void setMultilineValues(final boolean multilineValues) {
// parser.multilineValues = multilineValues;
// }
/**
* Parses input string and loads provided properties map.
*/
private /* synchronized */ void parse(final String data) {
initialized = false;
parser.parse(data);
}
/**
* Loads props from the string.
*/
public void load(final String data) {
parse(data);
}
// /**
// * Loads properties from input stream and provided encoding. Stream is not
// * closed at the end.
// */
// public void load(final InputStream in, final String encoding) throws IOException {
// final Writer out = new FastCharArrayWriter();
// copy(in, out, encoding);
// parse(out.toString());
// }
// /**
// * Loads base properties from the provided java properties. Null values are
// * ignored.
// */
// public void load(final Map p) {
// for (final Map.Entry entry : p.entrySet()) {
// final String name = entry.getKey().toString();
// final Object value = entry.getValue();
// if (value == null) {
// continue;
// }
// data.putBaseProperty(name, value.toString(), false);
// }
// }
public void load(final String name, final String value) {
data.putBaseProperty(name, value, false);
}
public void append(final String name, final String value) {
data.putBaseProperty(name, value, true);
}
// /**
// * Loads base properties from java Map using provided prefix. Null values
// * are ignored.
// */
// @SuppressWarnings("unchecked")
// public void load(final Map map, final String prefix) {
// String realPrefix = prefix.concat(".");
// for (final Map.Entry entry : map.entrySet()) {
// final String name = entry.getKey().toString();
// final Object value = entry.getValue();
// if (value == null) {
// continue;
// }
// data.putBaseProperty(realPrefix.concat(name), value.toString(), false);
// }
// }
//
// /**
// * Loads system properties with given prefix.
// * If prefix is null it will not be ignored.
// */
// public void loadSystemProperties(final String prefix) {
// final Properties environmentProperties = System.getProperties();
// load(environmentProperties, prefix);
// }
//
// // ---------------------------------------------------------------- props
//
// /**
// * Loads environment properties with given prefix.
// * If prefix is null it will not be used.
// */
// public void loadEnvironment(final String prefix) {
// final Map environmentMap = System.getenv();
// load(environmentMap, prefix);
// }
//
// /**
// * Counts the total number of properties, including all profiles.
// * This operation performs calculation each time and it might be
// * more time consuming then expected.
// */
// public int countTotalProperties() {
// return data.countBaseProperties() + data.countProfileProperties();
// }
// /**
// * Returns value of property, using active profiles.
// */
// public String getValue(final String key) {
// initialize();
// return data.lookupValue(key, activeProfiles);
// }
//
//
// // ---------------------------------------------------------------- put
//
// /**
// * Returns string value of given profiles. If key is not
// * found under listed profiles, base properties will be searched.
// * Returns null if property doesn't exist.
// */
// public String getValue(final String key, final String... profiles) {
// initialize();
// return data.lookupValue(key, profiles);
// }
// /**
// * Sets default value.
// */
// public void setValue(final String key, final String value) {
// setValue(key, value, null);
// }
// ---------------------------------------------------------------- extract
// /**
// * Sets value on some profile.
// */
// public void setValue(final String key, final String value, final String profile) {
// if (profile == null) {
// data.putBaseProperty(key, value, false);
// } else {
// data.putProfileProperty(key, value, profile, false);
// }
// initialized = false;
// }
/**
* Extracts props belonging to active profiles.
*/
public void extractProps(final Map target) {
initialize();
data.extract(target, activeProfiles);
}
// /**
// * Extract props of given profiles.
// */
// public void extractProps(final Map target, final String... profiles) {
// initialize();
// data.extract(target, profiles);
// }
/**
* Initializes props by replacing macros in values with the lookup values.
*/
private void initialize() {
if (initialized == false) {
//synchronized (this) {
// if (initialized == false) {
data.resolveMacros();
resolveActiveProfiles();
initialized = true;
// }
//}
}
}
/**
* Resolves active profiles from property. If default active property is not
* defined, nothing happens. Otherwise,
*/
private void resolveActiveProfiles() {
// if (activeProfilesProp == null) {
// activeProfiles = null;
// return;
// }
final PropsValue pv = data.getBaseProperty(activeProfilesProp);
if (pv == null) {
// no active profile set as the property, exit
return;
}
final String value = pv.getValue();
if (StringUtil.isBlank(value)) {
activeProfiles = null;
return;
}
activeProfiles = StringUtil.splitc(value, ',');
StringUtil.trimAll(activeProfiles);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy