Package rife.bld.extension.propertyfile

Class PropertyFileOperation

java.lang.Object

rife.bld.operations.AbstractOperation<PropertyFileOperation>

rife.bld.extension.propertyfile.PropertyFileOperation

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	comment(String comment)	Sets the comment to be inserted at the top of the Properties file.
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.
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.

Methods inherited from class rife.bld.operations.AbstractOperation

executeOnce, executeOnce, silent, silent

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

clear

public PropertyFileOperation clear()

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

Returns:

this instance

comment

public PropertyFileOperation comment(String comment)

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

Parameters:

comment - the header comment

Returns:

this instance

entry

public PropertyFileOperation entry(EntryBase<?> entry)

Adds an entry to specify modifications to the properties file.

Parameters:

entry - the entry

Returns:

this instance

execute

public void execute()
             throws Exception

Performs the modification(s) to the properties file.

Specified by:

execute in class AbstractOperation<PropertyFileOperation>

Throws:

Exception

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

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

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

file

public File file()

Retrieves the location of the Properties file to be edited.

Returns:

the properties file

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

fromProject

public PropertyFileOperation fromProject(BaseProject project)

Creates a new operation.

Parameters:

project - the project

Returns:

this instance