com.newrelic.agent.util

Class EditableFile

java.lang.Object

com.newrelic.agent.util.EditableFile

public class EditableFile
extends java.lang.Object

Provides a convenient wrapper API for editing files.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	comment

Constructor Summary

Constructors

Constructor and Description
EditableFile(java.lang.String filestr)

Method Summary

Modifier and Type	Method and Description
void	append(java.lang.String text) Appends the specified text to the file.
java.lang.String	backup() Write pending changes to a backup file (the original file name with a timestamp appended).
void	commentOutAllLinesMatching(java.lang.String regex) Comments out all lines matching the specified regex.
void	commentOutFirstLineMatching(java.lang.String regex) Comments out first line matching the specified regex.
boolean	contains(java.lang.String regex) Returns true if the file contains the specified regex, false otherwise.
java.lang.String	getContents() Returns the file contents in string format.
java.lang.String	getLocation() Returns the path to the file we are editing.
java.lang.String	insertAfterLocator(java.lang.String regex, java.lang.String textToInsert, boolean isMultiLine) Modifies the file to insert the specified text on the line after the *first* instance of the locator statement.
java.lang.String	insertBeforeLocator(java.lang.String regex, java.lang.String textToInsert, boolean isMultiLine) Modifies the file to insert the specified text on the line before the *first* instance of the locator statement.
java.lang.String	replaceAll(java.lang.String regex, java.lang.String replacement) Modifies the file to replace all occurrences of the specified regex with the specified replacement string.
java.lang.String	replaceAll(java.lang.String regex, java.lang.String replacement, boolean isMultiLine) Modifies the file to replace all occurrences of the specified regex with the specified replacement string.
java.lang.String	replaceFirst(java.lang.String regex, java.lang.String replacement) Modifies the file to replace the first occurrence of the specified regex with the specified replacement string.
java.lang.String	replaceFirst(java.lang.String regex, java.lang.String replacement, boolean isMultiLine) Modifies the file to replace the first occurrence of the specified regex with the specified replacement string.

Methods inherited from class java.lang.Object

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

Field Detail

comment

public final java.lang.String comment

Constructor Detail

EditableFile

public EditableFile(java.lang.String filestr)
             throws java.lang.NullPointerException,
                    java.io.FileNotFoundException,
                    java.io.IOException

Throws:

java.lang.NullPointerException

java.io.FileNotFoundException

java.io.IOException

Method Detail

getContents

public java.lang.String getContents()

Returns the file contents in string format.

getLocation

public java.lang.String getLocation()

Returns the path to the file we are editing.

contains

public boolean contains(java.lang.String regex)

Returns true if the file contains the specified regex, false otherwise. Regex metacharacters (dot, backslash, etc) will be interpreted as such unless they are escaped. For example, the regex "file.txt" will be found in "C:\\file.txt", but also "C:\\file-txt", "C:\\fileNtxt", etc. And this regex: "C:\\\\Some.*" will be found in "C:\\Some\\Arbitrary\\Windows\\Path\\File.txt", while the regex "C:\\Some.*" will not be found.

replaceFirst

public java.lang.String replaceFirst(java.lang.String regex,
                                     java.lang.String replacement)

Modifies the file to replace the first occurrence of the specified regex with the specified replacement string. Replacement is multiline, so ^ and $ can match the start and end of individual lines, or the start/end of the entire expression. The regex string must escape regex special characters for them to be interpreted as literals. The replacement string must escape dollar signs for them to be interpreted as literals. Otherwise, dollar signs will be interpreted as backreferences.

replaceFirst

public java.lang.String replaceFirst(java.lang.String regex,
                                     java.lang.String replacement,
                                     boolean isMultiLine)

Modifies the file to replace the first occurrence of the specified regex with the specified replacement string. Set multiline to true to have the ^ and $ metachars match the start and end of individual lines. Otherwise, they will only match the start/end of the entire expression. The regex string must escape regex special characters for them to be interpreted as literals. The replacement string must escape dollar signs for them to be interpreted as literals. Otherwise, dollar signs will be interpreted as backreferences.

replaceAll

public java.lang.String replaceAll(java.lang.String regex,
                                   java.lang.String replacement)

Modifies the file to replace all occurrences of the specified regex with the specified replacement string. Same regex special character handling as replaceFirst(String, String).

replaceAll

public java.lang.String replaceAll(java.lang.String regex,
                                   java.lang.String replacement,
                                   boolean isMultiLine)

Modifies the file to replace all occurrences of the specified regex with the specified replacement string. Same regex special character handling as replaceFirst(String, String, boolean).

insertBeforeLocator

public java.lang.String insertBeforeLocator(java.lang.String regex,
                                            java.lang.String textToInsert,
                                            boolean isMultiLine)

Modifies the file to insert the specified text on the line before the *first* instance of the locator statement. Set multiline to true to have the ^ and $ metachars match the start and end of individual lines. Otherwise, they will only match the start/end of the entire expression.

insertAfterLocator

public java.lang.String insertAfterLocator(java.lang.String regex,
                                           java.lang.String textToInsert,
                                           boolean isMultiLine)

Modifies the file to insert the specified text on the line after the *first* instance of the locator statement. Set multiline to true to have the ^ and $ metachars match the start and end of individual lines. Otherwise, they will only match the start/end of the entire expression.

commentOutFirstLineMatching

public void commentOutFirstLineMatching(java.lang.String regex)

Comments out first line matching the specified regex.

commentOutAllLinesMatching

public void commentOutAllLinesMatching(java.lang.String regex)

Comments out all lines matching the specified regex.

append

public void append(java.lang.String text)

Appends the specified text to the file.

backup

public java.lang.String backup()

Write pending changes to a backup file (the original file name with a timestamp appended).

Returns:

The name of the backup file, or an empty string if the file could not be written successfully.