com.softicar.platform.common.core.properties.PropertyFactory Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of platform-common Show documentation
The SoftiCAR Platform is a lightweight, Java-based library to create interactive business web applications.
There is a newer version: 50.0.0
package com.softicar.platform.common.core.properties;

import java.io.File;
import java.util.function.Function;

/**
 * A factory for instances of {@link IProperty}.
 *
 * @author Oliver Richers
 */
public class PropertyFactory extends AbstractPropertyFactory {

	private final IPropertyMap propertyMap;

	public PropertyFactory(IPropertyMap propertyMap, String namePrefix) {

		super(namePrefix);
		this.propertyMap = propertyMap;
	}

	/**
	 * Creates a boolean property.
	 * 
	 * The textual value of a boolean property may be true, yes or
	 * 1 for the value to represent true. For false the
	 * textual value may be false, no or 0.
	 *
	 * @param name
	 *            the name of the property
	 * @param defaultValue
	 *            the default value (may be null)
	 */
	public IProperty createBooleanProperty(String name, Boolean defaultValue) {

		return new Property<>(propertyMap, createName(name), defaultValue, this::parseBoolean);
	}

	/**
	 * Creates a property denoting an {@link Enum}.
	 * 

	 * The textual value of a property must exactly match the name of a
	 * enumerator.
	 *
	 * @param enumClass
	 *            the class of the {@link Enum}
	 * @param name
	 *            the name of the property
	 * @param defaultValue
	 *            the default value (may be null)
	 */
	public > IProperty createEnumProperty(Class enumClass, String name, E defaultValue) {

		return new Property<>(propertyMap, createName(name), defaultValue, valueString -> Enum.valueOf(enumClass, valueString));
	}

	/**
	 * Creates a property denoting a {@link File}.
	 * 
	 * A file property automatically expands leading tilde (~) characters into
	 * the home folder of the user, as defined by
	 * {@link SystemPropertyEnum#USER_HOME}. This is also works for the default
	 * value.
	 *
	 * @param name
	 *            the name of the property
	 * @param defaultValue
	 *            the default value (may be null)
	 */
	public IProperty createFileProperty(String name, String defaultValue) {

		return new Property<>(propertyMap, createName(name), parseFile(defaultValue), this::parseFile);
	}

	public IProperty createIntegerProperty(String name, Integer defaultValue) {

		return new Property<>(propertyMap, createName(name), defaultValue, Integer::parseInt);
	}

	public IProperty createLongProperty(String name, Long defaultValue) {

		return new Property<>(propertyMap, createName(name), defaultValue, Long::parseLong);
	}

	public IProperty createStringProperty(String name, String defaultValue) {

		return new Property<>(propertyMap, createName(name), defaultValue, Function.identity());
	}

	private Boolean parseBoolean(String stringValue) {

		if (isTrue(stringValue)) {
			return true;
		} else if (isFalse(stringValue)) {
			return false;
		} else {
			throw new IllegalArgumentException(String.format("Invalid boolean constant '%s'.", stringValue));
		}
	}

	private static boolean isTrue(String stringValue) {

		return stringValue.equalsIgnoreCase("true") || stringValue.equalsIgnoreCase("yes") || stringValue.equals("1");
	}

	private boolean isFalse(String stringValue) {

		return stringValue.equalsIgnoreCase("false") || stringValue.equalsIgnoreCase("no") || stringValue.equals("0");
	}

	public File parseFile(String valueString) {

		if (valueString == null) {
			return null;
		} else if (valueString.equals("~")) {
			valueString = SystemPropertyEnum.USER_HOME.get();
		} else if (valueString.startsWith("~" + SystemPropertyEnum.FILE_SEPARATOR.get())) {
			valueString = SystemPropertyEnum.USER_HOME.get() + valueString.substring(1);
		}

		return new File(valueString);
	}
}