rife2/bld-property-file
rife2/bld-property-file
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Converted EntryBase to a generic abstract class

Browse source
This commit is contained in:
Erik C. Thauvin 2024-07-16 16:07:52 -07:00
parent dacacbab56
commit 23540cbc8e
Signed by: erik
GPG key ID: 776702A6A2DA330E
7 changed files with 200 additions and 284 deletions
Download patch file Download diff file Expand all files Collapse all files

57
src/main/java/rife/bld/extension/propertyfile/Entry.java
View file

@ -25,62 +25,59 @@ import java.util.function.BiFunction;
* @author <a href="https://github.com/gbevin">Geert Bevin</a>
* @since 1.0
*/
public class Entry extends EntryBase {
public class Entry extends EntryBase<Entry> {
private String modifyValue_ = "";
private BiFunction<String, String, String> modify_;
/**
* Instantiates a new Entry.
* Creates a new {@link Entry entry}.
*
* @param key the key
* @param key the required property key
*/
public Entry(String key) {
super(key);
}
/**
* <p>Sets the initial value to set the {@link java.util.Properties property} to, if not already defined.</p>
* Returns the modify function.
*
* @param defaultValue the default value
* @return the entry
* @return the modify function
*/
@SuppressWarnings("unused")
public Entry defaultValue(Object defaultValue) {
setDefaultValue(defaultValue);
return this;
protected BiFunction<String, String, String> modify() {
return modify_;
}
/**
* Sets the {@link Entry entry} up for deletion.
* Sets the modify function.
*
* @return the entry
*/
public Entry delete() {
setDelete();
return this;
}
/**
* Creates a new {@link Entry entry}.
*
* @param modify the modification function
* @return the entry
* @param modify the modify function
*/
public Entry modify(BiFunction<String, String, String> modify) {
setModify(modify);
modify_ = modify;
return this;
}
/**
* Creates a new {@link Entry entry}.
* Sets the modify function.
*
* @param value the value to perform a modification with
* @param modify the modification function
* @return the entry
* @param modify the modify function
*/
public Entry modify(String value, BiFunction<String, String, String> modify) {
setModifyValue(value);
setModify(modify);
modifyValue_ = value;
modify_ = modify;
return this;
}
/**
* Returns the value to be used in the {@link #modify_} function.
*
* @return the modify value
*/
protected String modifyValue() {
return modifyValue_;
}
/**
* Sets the new {@link java.util.Properties property} value.
*
@ -88,7 +85,7 @@ public class Entry extends EntryBase {
* @return the entry
*/
public Entry set(Object s) {
setNewValue(s);
newValue(s);
return this;
}
}

174
src/main/java/rife/bld/extension/propertyfile/EntryBase.java
View file

@ -16,7 +16,6 @@
package rife.bld.extension.propertyfile;
import java.util.function.BiFunction;
import java.util.function.IntFunction;
/**
@ -26,17 +25,14 @@ import java.util.function.IntFunction;
* @author <a href="https://github.com/gbevin">Geert Bevin</a>
* @since 1.0
*/
@SuppressWarnings("PMD.DataClass")
public class EntryBase {
@SuppressWarnings({"unchecked", "PMD.AbstractClassWithoutAbstractMethod"})
public abstract class EntryBase<T> {
private IntFunction<Integer> calc_;
private Object defaultValue_;
private boolean isDelete_;
private String key_;
private String modifyValue_ = "";
private BiFunction<String, String, String> modify_;
private Object newValue_;
private String pattern_ = "";
private EntryDate.Units unit_ = EntryDate.Units.DAY;
private Object pattern_;
/**
* Creates a new {@link EntryBase entry}.
@ -52,71 +48,45 @@ public class EntryBase {
*
* @return the calc function
*/
protected IntFunction<Integer> getCalc() {
protected IntFunction<Integer> calc() {
return calc_;
}
/**
* Sets the calculation function.
*
* @param calc the calc function
*/
public T calc(IntFunction<Integer> calc) {
calc_ = calc;
return (T) this;
}
/**
* Returns the default value.
*
* @return the default value
*/
protected Object getDefaultValue() {
protected Object defaultValue() {
return defaultValue_;
}
/**
* Returns the key of the {@link java.util.Properties property}.
* Sets the initial value to set the {@link java.util.Properties property} to, if not already defined.
*
* @return the key
* @param defaultValue the default value
*/
protected String getKey() {
return key_;
public T defaultValue(Object defaultValue) {
defaultValue_ = defaultValue;
return (T) this;
}
/**
* Returns the modify function.
*
* @return the modify function
* Indicates that the {@link java.util.Properties property} is to be deleted.
*/
protected BiFunction<String, String, String> getModify() {
return modify_;
}
/**
* Returns the value to be used in the {@link #modify_} function.
*
* @return the modify value
*/
protected String getModifyValue() {
return modifyValue_;
}
/**
* Returns the new value to set the {@link java.util.Properties property)} to.
*
* @return the new value
*/
public Object getNewValue() {
return newValue_;
}
/**
* Returns the pattern.
*
* @return the pattern
*/
protected String getPattern() {
return pattern_;
}
/**
* Returns the {@link EntryDate.Units unit}.
*
* @return the unit
*/
protected EntryDate.Units getUnit() {
return unit_;
public T delete() {
isDelete_ = true;
return (T) this;
}
/**
@ -128,79 +98,33 @@ public class EntryBase {
return isDelete_;
}
/**
* Returns the key of the {@link java.util.Properties property}.
*
* @return the key
*/
protected String key() {
return key_;
}
/**
* Sets the key of the {@link java.util.Properties property}.
*
* @param key the {@link java.util.Properties property} key
* @return this instance
*/
@SuppressWarnings("unused")
public EntryBase key(String key) {
public T key(String key) {
key_ = key;
return this;
return (T) this;
}
/**
* Sets the calculation function.
* Returns the new value to set the {@link java.util.Properties property)} to.
*
* @param calc the calc function
* @return the new value
*/
protected void setCalc(IntFunction<Integer> calc) {
calc_ = calc;
}
/**
* Sets the initial value to set the {@link java.util.Properties property} to, if not already defined.
*
* @param defaultValue the default value
*/
protected void setDefaultValue(Object defaultValue) {
defaultValue_ = defaultValue;
}
/**
* Sets the {@link java.util.Properties property} to be deleted.
*/
protected void setDelete() {
isDelete_ = true;
}
/**
* Sets the key of the {@link java.util.Properties property}.
*
* @param key the {@link java.util.Properties property} key
*/
protected void setKey(String key) {
key_ = key;
}
/**
* Sets the modify function.
*
* @param modify the modify function
*/
protected void setModify(BiFunction<String, String, String> modify) {
modify_ = modify;
}
/**
* Sets the modify function.
*
* @param value the value to perform a modification with
* @param modify the modify function
*/
protected void setModify(String value, BiFunction<String, String, String> modify) {
modifyValue_ = value;
modify_ = modify;
}
/**
* Sets the modify value.
*
* @param value the modify value.
*/
protected void setModifyValue(String value) {
modifyValue_ = value;
protected Object newValue() {
return newValue_;
}
/**
@ -208,26 +132,26 @@ public class EntryBase {
*
* @param newValue the new value
*/
public void setNewValue(Object newValue) {
protected void newValue(Object newValue) {
newValue_ = newValue;
}
/**
* Sets the {@link java.text.DecimalFormat DecimalFormat} or {@link java.time.format.DateTimeFormatter DateTimeFormatter}
* pattern to be used with {@link EntryDate} or {@link EntryInt} respectively.
* Returns the pattern.
*
* @param pattern the pattern
* @return the pattern
*/
protected void setPattern(String pattern) {
pattern_ = pattern;
protected Object pattern() {
return pattern_;
}
/**
* Sets the {@link EntryDate.Units unit} value to apply to calculations.
* Sets the {@link java.util.Formatter} pattern.
*
* @param unit the {@link EntryDate.Units unit}
* @param pattern the pattern
*/
protected void setUnit(EntryDate.Units unit) {
unit_ = unit;
public T pattern(Object pattern) {
pattern_ = pattern;
return (T) this;
}
}

77
src/main/java/rife/bld/extension/propertyfile/EntryDate.java
View file

@ -19,7 +19,6 @@ package rife.bld.extension.propertyfile;
import java.time.*;
import java.util.Calendar;
import java.util.Date;
import java.util.function.IntFunction;
/**
* Declares the modifications to be made to a {@link java.util.Properties Date-based property}.
@ -27,9 +26,11 @@ import java.util.function.IntFunction;
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @since 1.0
*/
public class EntryDate extends EntryBase {
public class EntryDate extends EntryBase<EntryDate> {
private EntryDate.Units unit_ = EntryDate.Units.DAY;
/**
* Creates a new date {@link Entry entry}.
* Creates a new {@link EntryDate entry}.
*
* @param key the required property key
*/
@ -37,46 +38,13 @@ public class EntryDate extends EntryBase {
super(key);
}
/**
* Creates a new {@link EntryDate entry}.
*
* @param calc the calculation function
* @return this instance
*/
public EntryDate calc(IntFunction<Integer> calc) {
setCalc(calc);
return this;
}
/**
* Sets the {@link EntryDate entry} up for deletion.
*
* @return this instance
*/
public EntryDate delete() {
setDelete();
return this;
}
/**
* Sets the new {@link java.util.Properties property} value to now.
*
* @return this instance
*/
public EntryDate now() {
setNewValue("now");
return this;
}
/**
* Sets the pattern for {@link EntryInt} and {@link EntryDate} to{@link java.text.DecimalFormat DecimalFormat} and
* {@link java.time.format.DateTimeFormatter DateTimeFormatter} respectively.
*
* @param pattern the pattern
* @return this instance
*/
public EntryDate pattern(String pattern) {
setPattern(pattern);
newValue("now");
return this;
}
@ -87,7 +55,7 @@ public class EntryDate extends EntryBase {
* @return this instance
*/
public EntryDate set(Instant instant) {
setNewValue(instant);
newValue(instant);
return this;
}
@ -98,7 +66,7 @@ public class EntryDate extends EntryBase {
* @return this instance
*/
public EntryDate set(LocalDate date) {
setNewValue(date);
newValue(date);
return this;
}
@ -109,7 +77,7 @@ public class EntryDate extends EntryBase {
* @return this instance
*/
public EntryDate set(LocalDateTime date) {
setNewValue(date);
newValue(date);
return this;
}
@ -120,7 +88,7 @@ public class EntryDate extends EntryBase {
* @return this instance
*/
public EntryDate set(ZonedDateTime date) {
setNewValue(date);
newValue(date);
return this;
}
@ -131,7 +99,7 @@ public class EntryDate extends EntryBase {
* @return this instance
*/
public EntryDate set(LocalTime time) {
setNewValue(time);
newValue(time);
return this;
}
@ -142,7 +110,7 @@ public class EntryDate extends EntryBase {
* @return this instance
*/
public EntryDate set(Calendar cal) {
setNewValue(cal);
newValue(cal);
return this;
}
@ -153,10 +121,19 @@ public class EntryDate extends EntryBase {
* @return this instance
*/
public EntryDate set(Date date) {
setNewValue(date);
newValue(date);
return this;
}
/**
* Returns the {@link EntryDate.Units unit}.
*
* @return the unit
*/
public EntryDate.Units unit() {
return unit_;
}
/**
* Sets the {@link Units unit} value to apply to calculations for {@link EntryDate}.
*
@ -164,7 +141,17 @@ public class EntryDate extends EntryBase {
* @return this instance
*/
public EntryDate unit(Units unit) {
setUnit(unit);
unit_ = unit;
return this;
}
/**
* Sets the {@link java.time.format.DateTimeFormatter DateTimeFormatter} pattern.
*
* @param pattern the pattern
*/
public EntryDate pattern(String pattern) {
super.pattern(pattern);
return this;
}

51
src/main/java/rife/bld/extension/propertyfile/EntryInt.java
View file

@ -16,17 +16,15 @@
package rife.bld.extension.propertyfile;
import java.util.function.IntFunction;
/**
* Declares the modifications to be made to an {@link java.util.Properties Integer-based property}.
*
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @since 1.0
*/
public class EntryInt extends EntryBase {
public class EntryInt extends EntryBase<EntryInt> {
/**
* Creates a new date {@link Entry entry}.
* Creates a new {@link EntryInt entry}.
*
* @param key the required property key
*/
@ -34,39 +32,6 @@ public class EntryInt extends EntryBase {
super(key);
}
/**
* Creates a new {@link EntryInt entry}.
*
* @param calc the calculation function.
* @return this instance
*/
public EntryInt calc(IntFunction<Integer> calc) {
setCalc(calc);
return this;
}
/**
* Sets the initial value to set the {@link java.util.Properties property} to, if not already defined.
*
* @param defaultValue the default value
* @return this instance
*/
@SuppressWarnings("unused")
public EntryInt defaultValue(Object defaultValue) {
setDefaultValue(defaultValue);
return this;
}
/**
* Sets the {@link EntryInt entry} up for deletion.
*
* @return this instance
*/
public EntryInt delete() {
setDelete();
return this;
}
/**
* Sets the new {@link java.util.Properties property} value to an integer.
*
@ -74,7 +39,17 @@ public class EntryInt extends EntryBase {
* @return this instance
*/
public EntryInt set(int i) {
setNewValue(i);
newValue(i);
return this;
}
/**
* Sets the {@link java.text.DecimalFormat DecimalFormat} pattern.
*
* @param pattern the pattern
*/
public EntryInt pattern(String pattern) {
super.pattern(pattern);
return this;
}
}

70
src/main/java/rife/bld/extension/propertyfile/PropertyFileOperation.java
View file

@ -18,11 +18,14 @@ package rife.bld.extension.propertyfile;
import rife.bld.BaseProject;
import rife.bld.operations.AbstractOperation;
import rife.bld.operations.exceptions.ExitStatusException;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* Creates or applies edits to a {@link Properties Properties} file.
@ -31,7 +34,8 @@ import java.util.Properties;
* @since 1.0
*/
public class PropertyFileOperation extends AbstractOperation<PropertyFileOperation> {
private final List<EntryBase> entries_ = new ArrayList<>();
private final static Logger LOGGER = Logger.getLogger(PropertyFileOperation.class.getName());
private final List<EntryBase<?>> entries_ = new ArrayList<>();
private String comment_ = "";
private boolean failOnWarning_;
private File file_;
@ -55,8 +59,7 @@ public class PropertyFileOperation extends AbstractOperation<PropertyFileOperati
* @param entry the {@link Entry entry}
* @return this instance
*/
@SuppressWarnings("unused")
public PropertyFileOperation entry(EntryBase entry) {
public PropertyFileOperation entry(EntryBase<?> entry) {
entries_.add(entry);
return this;
}
@ -66,38 +69,49 @@ public class PropertyFileOperation extends AbstractOperation<PropertyFileOperati
*/
@Override
public void execute() throws Exception {
if (project_ == null) {
if (LOGGER.isLoggable(Level.SEVERE) && !silent()) {
LOGGER.log(Level.SEVERE, "A project is required");
}
throw new ExitStatusException(ExitStatusException.EXIT_FAILURE);
}
var commandName = project_.getCurrentCommandName();
var properties = new Properties();
var success = false;
var success = true;
if (file_ == null) {
PropertyFileUtils.warn(commandName, "A properties file must be specified.");
warn(commandName, "A properties file must be specified.");
} else {
success = PropertyFileUtils.loadProperties(commandName, file_, properties);
success = PropertyFileUtils.loadProperties(commandName, file_, properties, silent());
}
if (success) {
for (var entry : entries_) {
if (entry.getKey().isBlank()) {
PropertyFileUtils.warn(commandName, "An entry key must specified.");
if (entry.key().isBlank()) {
warn(commandName, "An entry key must specified.");
} else {
var key = entry.getKey();
Object value = entry.getNewValue();
Object defaultValue = entry.getDefaultValue();
var key = entry.key();
Object value = entry.newValue();
Object defaultValue = entry.defaultValue();
var p = properties.getProperty(key);
if (entry.isDelete()) {
properties.remove(key);
} else if ((value == null || String.valueOf(value).isBlank())
&& (defaultValue == null || String.valueOf(defaultValue).isBlank())
&& (p == null || p.isBlank())) {
PropertyFileUtils.warn(commandName, "An entry must be set or have a default value: " + key);
warn(commandName, "An entry must be set or have a default value: " + key);
} else {
if (entry instanceof EntryDate) {
success = PropertyFileUtils.processDate(commandName, properties, (EntryDate) entry, failOnWarning_);
} else if (entry instanceof EntryInt) {
success = PropertyFileUtils.processInt(commandName, properties, (EntryInt) entry, failOnWarning_);
} else {
success = PropertyFileUtils.processString(properties, (Entry) entry);
try {
if (entry instanceof EntryDate) {
PropertyFileUtils.processDate(properties, (EntryDate) entry);
} else if (entry instanceof EntryInt) {
PropertyFileUtils.processInt(properties, (EntryInt) entry);
} else {
PropertyFileUtils.processString(properties, (Entry) entry);
}
} catch (IllegalArgumentException e) {
warn(commandName, e.getMessage());
}
}
}
@ -152,4 +166,24 @@ public class PropertyFileOperation extends AbstractOperation<PropertyFileOperati
project_ = project;
return this;
}
/**
* Logs a warning.
*
* @param command The command name
* @param message the message log
* @throws ExitStatusException if a {@link Level#SEVERE} exception occurs
*/
private void warn(String command, String message) throws ExitStatusException {
if (failOnWarning_) {
if (LOGGER.isLoggable(Level.SEVERE) && !silent()) {
LOGGER.log(Level.SEVERE, '[' + command + "] " + message);
throw new ExitStatusException(ExitStatusException.EXIT_FAILURE);
}
} else {
if (LOGGER.isLoggable(Level.WARNING) && !silent()) {
LOGGER.warning('[' + command + "] " + message);
}
}
}
}

47
src/main/java/rife/bld/extension/propertyfile/PropertyFileUtils.java
View file

@ -16,7 +16,8 @@
package rife.bld.extension.propertyfile;
import javax.imageio.IIOException;
import rife.bld.operations.exceptions.ExitStatusException;
import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
@ -69,22 +70,22 @@ public final class PropertyFileUtils {
* @param file the file location
* @param p the {@link Properties properties} to load into.
* @return the boolean
* @throws Exception the exception
* @throws ExitStatusException if an error occurred
*/
@SuppressWarnings("PMD.SignatureDeclareThrowsException")
public static boolean loadProperties(String command, File file, Properties p) throws Exception {
public static boolean loadProperties(String command, File file, Properties p, boolean silent)
throws ExitStatusException {
boolean success = true;
if (file != null) {
if (file.exists()) {
try (var propStream = Files.newInputStream(file.toPath(), StandardOpenOption.READ)) {
p.load(propStream);
} catch (IOException ioe) {
warn(command, "Could not load properties file: " + ioe.getMessage(), ioe, true);
warn(command, "Could not load properties file: " + ioe.getMessage(), true, silent);
success = false;
}
}
} else {
warn(command, "Please specify the properties file location.");
warn(command, "Please specify the properties file location.", true, silent);
success = false;
}
return success;
@ -261,20 +262,8 @@ public final class PropertyFileUtils {
public static void saveProperties(File file, String comment, Properties p) throws IOException {
try (var output = Files.newOutputStream(file.toPath())) {
p.store(output, comment);
} catch (IIOException ioe) {
throw new IIOException("An IO error occurred while saving the Properties file: " + file, ioe);
}
}
/**
* Logs a warning.
*
* @param command the issuing command
* @param message the message to log
*/
static void warn(String command, String message) {
if (LOGGER.isLoggable(Level.WARNING)) {
LOGGER.warning('[' + command + "] " + message);
} catch (IOException ioe) {
throw new IOException("An IO error occurred while saving the Properties file: " + file, ioe);
}
}
@ -283,18 +272,20 @@ public final class PropertyFileUtils {
*
* @param command The command name
* @param message the message log
* @param e the related exception
* @param failOnWarning logs and throws exception if set to {@code true}
* @throws Exception the exception
* @throws ExitStatusException if a {@link Level#SEVERE} exception occurs
*/
@SuppressWarnings({"PMD.SignatureDeclareThrowsException"})
static void warn(String command, String message, Exception e, boolean failOnWarning) throws Exception {
LOGGER.warning("ahah");
static void warn(String command, String message, boolean failOnWarning, boolean silent)
throws ExitStatusException {
if (failOnWarning) {
LOGGER.log(Level.SEVERE, '[' + command + "] " + message, e);
throw e;
if (LOGGER.isLoggable(Level.SEVERE) && !silent) {
LOGGER.log(Level.SEVERE, '[' + command + "] " + message);
}
throw new ExitStatusException(ExitStatusException.EXIT_FAILURE);
} else {
warn(command, message);
if (LOGGER.isLoggable(Level.WARNING) && !silent) {
LOGGER.warning('[' + command + "] " + message);
}
}
}
}

8
src/test/java/rife/bld/extension/propertyfile/PropertyFileOperationTest.java
View file

@ -18,6 +18,7 @@ package rife.bld.extension.propertyfile;
import org.junit.jupiter.api.Test;
import rife.bld.Project;
import rife.bld.operations.exceptions.ExitStatusException;
import java.io.File;
import java.nio.file.Files;
@ -26,6 +27,7 @@ import java.time.format.DateTimeFormatter;
import java.util.Properties;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatCode;
import static rife.bld.extension.propertyfile.Calc.ADD;
class PropertyFileOperationTest {
@ -76,4 +78,10 @@ class PropertyFileOperationTest {
assertThat(p.getProperty("build.date")).as("dalete build.date").isNull();
assertThat(p).as("version keys").containsKeys("version.major", "version.minor", "version.patch");
}
@Test
void testExecuteNoProject() {
var op = new PropertyFileOperation();
assertThatCode(op::execute).isInstanceOf(ExitStatusException.class);
}
}