Package rife.bld.extension.propertyfile

Class PropertyFileOperation

java.lang.Object

rife.bld.operations.AbstractOperation<PropertyFileOperation>

rife.bld.extension.propertyfile.PropertyFileOperation

@NullMarked
public class PropertyFileOperation
extends AbstractOperation<PropertyFileOperation>

Creates or applies edits to a Properties file.

Since:

1.0

Author:

Erik C. Thauvin

Constructor Summary

Constructors

Constructor	Description
PropertyFileOperation()

Method Summary

Modifier and Type	Method	Description
PropertyFileOperation	clear()	Marks the operation to clear all existing entries in the target properties file before applying further modifications.
PropertyFileOperation	clear(boolean clear)	Sets whether all existing entries in the target properties file should be cleared before applying further modifications.
PropertyFileOperation	comment(String comment)	Sets the comment to be inserted at the top of the Properties file.
List<EntryBase<?>>	entries()	Retrieves an unmodifiable view of the configured entries.
PropertyFileOperation	entry(EntryBase<?> entry)	Adds an entry to specify modifications to the properties file.
void	execute()	Performs the modification(s) to the properties file.
PropertyFileOperation	failOnWarning(boolean failOnWarning)	Sets the execution to return a failure on any warnings.
@Nullable File	file()	Retrieves the location of the Properties file to be edited.
PropertyFileOperation	file(File file)	Sets the location of the Properties file to be edited.
PropertyFileOperation	file(String file)	Sets the location of the Properties file to be edited.
PropertyFileOperation	file(Path file)	Sets the location of the Properties file to be edited.
PropertyFileOperation	fromProject(BaseProject project)	Creates a new operation.
boolean	isClear()	Indicates whether all existing entries will be cleared before modifications are applied.
boolean	isFailOnWarning()	Indicates whether the execution will return a failure on any warnings.

Methods inherited from class rife.bld.operations.AbstractOperation

executeOnce, executeOnce, silent, silent, verbose, verbose

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PropertyFileOperation

public PropertyFileOperation()

Method Details

execute

public void execute()
             throws Exception

Performs the modification(s) to the properties file.

Specified by:

execute in class AbstractOperation<PropertyFileOperation>

Throws:

Exception

clear

public PropertyFileOperation clear()

Marks the operation to clear all existing entries in the target properties file before applying further modifications.

Returns:

this instance

See Also:

• clear(boolean)

clear

public PropertyFileOperation clear(boolean clear)

Sets whether all existing entries in the target properties file should be cleared before applying further modifications.

Parameters:

clear - if set to true, all existing entries will be cleared first

Returns:

this instance

See Also:

• clear()
• isClear()

comment

public PropertyFileOperation comment(String comment)

Sets the comment to be inserted at the top of the Properties file.

Parameters:

comment - the header comment; must not be null

Returns:

this instance

Throws:

NullPointerException - if comment is null

entries

public List<EntryBase<?>> entries()

Retrieves an unmodifiable view of the configured entries.

Returns:

the list of entries

entry

public PropertyFileOperation entry(EntryBase<?> entry)

Adds an entry to specify modifications to the properties file.

Parameters:

entry - the entry

Returns:

this instance

Throws:

NullPointerException - if entry is null

failOnWarning

public PropertyFileOperation failOnWarning(boolean failOnWarning)

Sets the execution to return a failure on any warnings.

Parameters:

failOnWarning - if set to true, the execution will fail on any warnings.

Returns:

this instance

See Also:

• isFailOnWarning()

file

public PropertyFileOperation file(File file)

Sets the location of the Properties file to be edited.

Parameters:

file - the file to be edited

Returns:

this instance

Throws:

NullPointerException - if file is null

file

public PropertyFileOperation file(String file)

Sets the location of the Properties file to be edited.

Parameters:

file - the file to be edited

Returns:

this instance

Throws:

NullPointerException - if file is null

IllegalArgumentException - if file is empty

file

public @Nullable File file()

Retrieves the location of the Properties file to be edited.

Returns:

the properties file or null if not set

file

public PropertyFileOperation file(Path file)

Sets the location of the Properties file to be edited.

Parameters:

file - the file to be edited

Returns:

this instance

Throws:

NullPointerException - if file is null

fromProject

public PropertyFileOperation fromProject(BaseProject project)

Creates a new operation.

Parameters:

project - the project

Returns:

this instance

Throws:

NullPointerException - if project is null

isClear

public boolean isClear()

Indicates whether all existing entries will be cleared before modifications are applied.

Returns:

true if existing entries will be cleared; false otherwise

See Also:

• clear(boolean)

isFailOnWarning

public boolean isFailOnWarning()

Indicates whether the execution will return a failure on any warnings.

Returns:

true if the execution will fail on warnings; false otherwise

See Also:

• failOnWarning(boolean)