FuR ( Frame4J -- the Java framework de.frame4j... )

java.lang.Object
- de.frame4j.util.App
- - de.frame4j.FuR

All Implemented Interfaces:

AttrSettable, TextHelper.MessageComponents, AppMBean, ComVar, UIInfo, ActionListener, EventListener
```
@MinDoc(copyright="Copyright 2009 - 2017, 2021  A. Weinert",
        author="Albrecht Weinert",
        version="V.65",
        lastModified="3.06.2024",
        usage="start as Java application (-? for help)",
        purpose="find and replace multiple texts in multiple files")
public class FuR
extends App
```
Find texts in files and replace them.

This application visits text files in a start directory and optionally (option -r) recursively in its sub-directories, too. All file and directory criteria available for Frame4J applications may be used.

In every file visited all occurrences of old text patterns are searched for and replaced by a new or substitute pattern. The old pattern may be specified as single text (properties "old"), in the sense of:
replace every occurrence of "<br>" (old) by "<br \>" (new).

On the other hand every text pattern to be replaced can be specified as bracketed by two sequences (old and oldEnd) with arbitrary content in between, in the sense of:
replace everything between "" (oldEnd) by nothing "" (new).
The regular expression for the example would be """".

One single replacement task (for every specified file)
oldText, [oldEnd,] newText
can be specified by start parameters (command line / script). The application can also handle up to 188 replacement commands/pattern specified in an extra .properties or up to 999 [de-] hyphenations (as special replacements) given in a hyphenation specification file. These replacements are worked through for every text file content sequentially (in the defined order).
The properties
old, [end,] new|newFile [ignoreCase] [ignoreWS] [keepBraces]
are the given in the form
old0, [end0,] new0 to (max.) old150, [end150,] new150
governed by Prop's syntax for indexed properties (new150 and new[150] would both be recognised, e.g.).

The meaning hereby is
- newFile instead of new: the associated substitute text is not given directly but read from the textfile named.
  Multiply named files — newFile132=partner_links.txt and newFile[17]=partner_links.txt for example — are read only once. Such a file not being readable, aborts the application.
- useNewModif: if true (and keepFileDate = true) the modification date of a modified file will be set to the maximum of it's own old file date and that of all used replacement files for which that property is true. (In other words: it's possible if a newer file is inserted into an older one, to set the newer include file's date.)
- ignoreCase, ignoreWS: ignore case respectively embedded white space bay matching old or old-oldEnd-braces.
- keepBraces: set old and oldEnd (both search braces if given) in front and at the end of the substitute text (new or newFile content).
Remark 1: The newFile/keepBraces feature is heavily used to get a "include files" for languages without that feature (like HTML respectively Java). See also the method TextHelper.fUr(CharSequence, ..) used, of course, in this application's FileVisitors.

Remark 2: Obviously the application does not use regular expressions for text matching. But the bracing and ignore white space features, when used well, are a good, robust and performing substitute in most cases. They give enough freedom in white space ignoring languages like HTML, XML and Java.

This application's real power shows up when doing many dozens of replacements in many hundred files, selected by complex criteria, in one step. Voluminous changes and maintenance work on web spaces have been specified in one .properties file and done orders of magnitude faster and more robust than by script programmed nested loops and transformations.

Besides these big "some 100 replacements times hundreds of files" use cases, this application also does the little every day things. Examples:
java FuR -i .\+.java -r de.weaut de.weAut
replaces in all files *.java in the actual tree the text de.weaut in any case by the same text in the correct case.

java FuR .\+.html "<br>" "<br />" -i -r
replaces in all .html files frumpish breaks by the good ones loved by XML.

java FuR jdk1.3\docs\de\frame4j\+.html api\ api/ -i -v
replaces in all .html files api\ by api/ so repairing a fault done by quite many javaDoc.exe versions in Java3 days when doing relative linking.

[De-] hyphenation: A special find and replace feature is replacing words without soft hyphen entities by words with them, like
Feuerwehrhauptmann ==> Feuerwehrhauptmann – or the other way round.
One only needs a hyphenation definition file with one  hyphenated word per per line made according to the example hyphTest.txt.
The hyphenation definition file's default encoding is UTF-8, everywhere; use options -hyphEnc ISO8859-1 , e.g. or -hyphISO1 to change.

Hint 1: In some cases, like text and layout files for jekyll, it might be advisable to exclude the front matter from all text changes by FuR (use option -omitFrntMt).

Hint 2: The file FuR.properties is an integral part of this application. It's placed in the same directory (usually within the deployment .jar) as FuR.class. The file FuR.properties may be regarded as part of the documentation.

© Copyright 2000 - 2004, 2009, 2015 Albrecht Weinert
See Also:

App, AppBase, Prop

Nested Class Summary
- Nested classes/interfaces inherited from interface de.frame4j.util.ComVar
  ComVar.Impl

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`deHyphen` Hyphenate or de-hyphenate.
`String`	`directory` Start directory.
`protected String[]`	`fileNs` Replacement text / substitute file name; (multiple).
`String`	`filModEnc` Encoding of files to be modified.
`boolean`	`forward` Sequence of (multiple) replacements.
`String`	`hypFilEnc` Encoding of the hyphenation definition file.
`boolean`	`hyphen` Hyphenate or de-hyphenate.
`String`	`hyphFile` Path of the hyphenation definition file.
`protected boolean[]`	`ignCase` Ignore case for search text matching (multiple).
`String`	`ignFilesWith` Exclude text.
`String`	`ignFilesWith2` Exclude text (number 2).
`boolean`	`ignoreCase` Ignore case for search text matching.
`boolean`	`ignoreWS` Ignore white spaces for search text matching.
`protected boolean[]`	`ignWS` Ignore white spaces search text matching (multiple).
`boolean`	`incFileDate` Add (only) 1/2 s the last file in case of replacements.
`protected boolean[]`	`keepBrace` Keep the braces, when replacing text (multiple).
`boolean`	`keepBraces` Keep the braces, when replacing text.
`boolean`	`keepFileDate` Keep the file date even after replacements.
`protected long[]`	`newModif` Modification date for the substitute (multiple).
`protected String[]`	`newT` Replacement text; substitute (multiple).
`String`	`newText` Replacement text; substitute.
`protected String[]`	`oldE` Search text, end (multiple).
`String`	`oldEnd` Search text (end).
`protected String[]`	`oldT` Search text (multiple).
`String`	`oldText` Search text (begin).
`boolean`	`omitFrntMt` Omit front matter.
`boolean`	`recursion` Recursively visit sub-directories.
`boolean`	`sortHyphDefs` Sort hyphenation definitions by descending length.
`String`	`types` File types to regard.
`boolean`	`useNewModif` Use the modification time of the replacement text or substitute.

Fields inherited from class de.frame4j.util.App
ano, appBase, appIO, appStartTime, appStartTimeMS, args, argsOrig, bgColor, err, fullClassName, help, icon, log, mainThread, myClass, myFrame, name, out, outMode, packName, prop, retCode, runFlag, shortClassName, title, verbose, verbosity

Fields inherited from interface de.frame4j.util.ComVar
AUTHOR, BLANK_STRING, cons, CONSOL_ENCODING, COPYRIGHT, D, D_NaN, D_NegInf, D_PosInf, EMPTY_INT_A, EMPTY_STRING, FILE_ENCODING, FRW_CLLD, FS, FSS, H, hasCons, HOST_IP, HOST_IPv4, HOST_NAME, INIT_ERROR, JAR_ENCODING, JH, JOB_DONE_OK, JRL, LOG_OUT_ERROR, M, MAIN_THREAD_EXC, NO_BYTES, NO_CLASSES, NO_DOUBLES, NO_OBJECTS, NO_PARS_ERROR, NO_STRINGS, NOT_WINDOWS, ON_PI, ONE_DAY, ONE_HOUR, ONE_LEAP_YEAR, ONE_MINUTE, ONE_SECOND, ONE_WEEK, ONE_YEAR, OS, PROG_NAME, PROG_SHORT, PS, RUNTIME, S, SHY, UD, UL, UL_UR_da, UR

Fields inherited from interface de.frame4j.net.AttrSettable
ILLEGAL_TYPE, ILLEGAL_VALUE, NO_ATTRIBUTE, NO_KNOWN_ATTRIBUTE, NO_VALUE, OK, retVtext

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`doIt()` Working method of FuR.
`static void`	`main(String[] args)` Start method of FuR .
`boolean`	`parsePartial()` Partial start parameter parsing by Prop.

Methods inherited from class de.frame4j.util.App
actionPerformed, allowNoPropertiesFile, clientOrder, condHelpLog, connect, errMeld, errMeld, errorExit, errorExit, errorText, extraPropertiesFile, formMessage, formMessage, formMessage, getAbout, getAboutText, getActTime, getAppLogger, getAppStartTime, getArgs, getAuthor, getCopyright, getDbLogger, getExecTimeMs, getExecTimeMsL, getExecTimeString, getHelp, getHelpText, getIcon, getLanguage, getLogHandler, getMessageComponent, getMessageComponentsLength, getMyFrame, getName, getNameWithVersDate, getOutMode, getProp, getPurpose, getStartTime, getStateString, getTheCloser, getTitle, getUsage, getVerbose, getVerbosity, getVersDate, go, go, go, haveIcon, isDebug, isHelp, isHelpLog, isNormal, isRunFlag, isSilent, isTest, isVerbose, logVerbose, logVerbose, makeStatusTextEnd, makeStatusTextStart, messageFormat, normalExit, performeAction, queueAction, regAsStdMBean, repExc, setAboutText, setAttribute, setAttribute, setAuthor, setBgColor, setCodePages, setCopyright, setHelp, setLogOut2, setName, setOutMode, setOutMode, setPurpose, setTitle, setUsage, setVerbose, setVerbose, setVerbosity, setVerbosity, setVersDate, stop, threeLineEndMsg, toString, twoLineEndMsg, twoLineStartMsg, valueLang, valueLang, wakeMainThread

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.frame4j.net.AttrSettable
retVtext

- Field Detail
  - hyphen
```
public boolean hyphen
```
    Hyphenate or de-hyphenate.
    
    If one of hyphen or deHyphen is true FuR gets its old / new find and replace pattern from the text file hyphFile only.
    If both are true the program ends with an error message.
    
    Since:
    
    July 2021
  - deHyphen
```
public boolean deHyphen
```
    Hyphenate or de-hyphenate.
    
    If one of hyphen or deHyphen is true FuR gets its old / new find and replace pattern from the text file hyphFile only.
    If both are true the program ends with an error message.
    
    Since:
    
    July 2021
  - hyphFile
```
public String hyphFile
```
    Path of the hyphenation definition file.
    
    This is a strict one hyphenated (by ) word per line text file:
```
   Klas&shy;sen&shy;ver&shy;band
   Feuer&shy;wehr&shy;haupt&shy;mann
   twelve&shy;year&shy;old
   anx&shy;ious
   stu&shy;pid
```
    Note 1: In most cases, it is better to have language specific hyphenation definition files.
    Note 2: If you happen to have a good hyphenation definition file having hyphens -; instead of the XML entity , let this program FuR replace the first with the latter:
    java de.frame4j.FuR myHyphFile.txt "-" "" -v
    See Also:
    
    hyphen, deHyphen
  - sortHyphDefs
```
public boolean sortHyphDefs
```
    Sort hyphenation definitions by descending length.
    
    If true (default), before their use, the hyphenation definitions will sorted by descending length of the words not counting the s.
    
    Since:
    
    31.07.2021 Rev. 62, Implementation-Version: 1.21.07
  - hypFilEnc
```
public String hypFilEnc
```
    Encoding of the hyphenation definition file.
    
    Default: UTF-8
    
    See Also:
    
    hyphFile
  - omitFrntMt
```
public boolean omitFrntMt
```
    Omit front matter.
    
    If true a jekyll front matter is searched for in each file to be processed and, if found, this front matter part at the very beginning will be left untouched.
    default: false
    
    See Also:
    
    TextHelper.isFrntMttr(CharSequence)
  - recursion
```
public boolean recursion
```
    Recursively visit sub-directories.
    
    If true also files in sub-directories are considered and if applicable worked on.
    
    default: false
  - oldText
```
public String oldText
```
    Search text (begin).
    
    This is the complete search (or old) text or the opening brace for a spot to be replaced.
    
    See Also:
    
    oldEnd
  - oldEnd
```
public String oldEnd
```
    Search text (end).
    
    Is oldEnd not null or empty, then oldText and oldEnd form braces to find a spot for replacement. An exemplary use would be two distinct HTML comments to mark a spot for inserting or replacing a new text (block).
    
    Note that the new text(s) may be given as (text) value, also multi-line, or as a path to a file. The difference is specified by the name of the (indexed) property: new[32] versus newFile[32]
  - newText
```
public String newText
```
    Replacement text; substitute.
  - useNewModif
```
public boolean useNewModif
```
    Use the modification time of the replacement text or substitute.
    
    If useNewModif is true and if the replacement text has a modification date (because read from a file) and if the modification date is to be kept (keepFileDate is true)
    then the maximum of the file modification dates is used as the (new) modification date.
    
    Note: this single property useNewModif is used as default for all indexed properties useNewModif[32].
    Note 2: These properties have no effect if keepFileDate is false.
    
    default: true
  - keepFileDate
```
public boolean keepFileDate
```
    Keep the file date even after replacements.
    
    default: true
    
    See Also:
    
    incFileDate
  - incFileDate
```
public boolean incFileDate
```
    Add (only) 1/2 s the last file in case of replacements.
    
    Like @link keepFileDate, but with a tiny increase of the last file modification date.
    The purpose is a sticking to the last otherwise done file modification date, but nevertheless having a little time difference to an unmodified copy.
    Some tools like Update might otherwise refrain from from necessary updates.
    
    default: true
  - ignoreCase
```
public boolean ignoreCase
```
    Ignore case for search text matching.
    
    If true the matching of the oldText oldEnd pattern is not case sensitive.
    
    Note: this single property ignoreCase is used as default for all indexed properties ignoreCase[32].
    
    default: false
  - ignoreWS
```
public boolean ignoreWS
```
    Ignore white spaces for search text matching.
    
    If true the matching of the oldText oldEnd pattern ignores embedded white spaces in the pattern and the original text.
    
    Note: this single property ignoreWS is used as default for all indexed properties ignoreWS[32].
    
    default: false
  - oldT
```
protected String[] oldT
```
    Search text (multiple).
    
    See Also:
    
    oldText
  - oldE
```
protected String[] oldE
```
    Search text, end (multiple).
    
    See Also:
    
    oldEnd
  - ignCase
```
protected boolean[] ignCase
```
    Ignore case for search text matching (multiple).
    
    See Also:
    
    ignoreCase
  - ignWS
```
protected boolean[] ignWS
```
    Ignore white spaces search text matching (multiple).
    
    See Also:
    
    ignoreWS
  - newT
```
protected String[] newT
```
    Replacement text; substitute (multiple).
  - fileNs
```
protected String[] fileNs
```
    Replacement text / substitute file name; (multiple).
  - newModif
```
protected long[] newModif
```
    Modification date for the substitute (multiple).
  - keepBraces
```
public boolean keepBraces
```
    Keep the braces, when replacing text.
    
    default: true
  - keepBrace
```
protected boolean[] keepBrace
```
    Keep the braces, when replacing text (multiple).
  - ignFilesWith
```
public String ignFilesWith
```
    Exclude text.
    
    Is ignFilesWith not null or empty, files containing this text as is will not be touched (even if matching the visitor's file and directory criteria).
    
    If this stopper text is inserted by one run of FuR that's the procedure to inhibit multiple works on the same file.
    
    default: null
  - ignFilesWith2
```
public String ignFilesWith2
```
    Exclude text (number 2).
    
    Same effect as ignFilesWith. (Both excluding conditions are ORed.)
  - forward
```
public boolean forward
```
    Sequence of (multiple) replacements.
    
    default: true, i.e. forward respectively 0 .. anzAltNeu- 1
  - directory
```
public String directory
```
    Start directory.
  - types
```
public String types
```
    File types to regard.
  - filModEnc
```
public String filModEnc
```
    Encoding of files to be modified.
    
    The name of the real/current encoding of the text files to be modified. It must fit and is not changed.
    
    No explicit setting (null) defaults to the platform encoding.
    
    Since:
    
    January 2017
- Method Detail
  - parsePartial
```
public boolean parsePartial()
```
    Partial start parameter parsing by Prop.
    
    Overrides:
    
    parsePartial in class App
    
    Returns:
    
    false except when made by the make'n go constructor App(String[])
  - main
```
public static void main(String[] args)
```
    Start method of FuR .
    
    Return code:
    Exit = 0, run successfully,
    Exit >0 error(s) while running,
    Exit >90 parameter or start errors; nothing done.
    
    Parameters:
    
    args - command line start parameters
  - doIt
```
public int doIt()
```
    Working method of FuR.
    
    Specified by:
    
    doIt in class App
    
    Returns:
    
    the exit code; 0 means OK
    
    See Also:
    
    Prop, App.go(String[]), App.go(String[], String, CharSequence), App.mainThread

Class FuR

Nested Class Summary

Nested classes/interfaces inherited from interface de.frame4j.util.ComVar

Field Summary

Fields inherited from class de.frame4j.util.App

Fields inherited from interface de.frame4j.util.ComVar

Fields inherited from interface de.frame4j.net.AttrSettable

Method Summary

Methods inherited from class de.frame4j.util.App

Methods inherited from class java.lang.Object

Methods inherited from interface de.frame4j.net.AttrSettable

Field Detail

hyphen

deHyphen

hyphFile

sortHyphDefs

hypFilEnc

omitFrntMt

recursion

oldText

oldEnd

newText

useNewModif

keepFileDate

incFileDate

ignoreCase

ignoreWS

oldT

oldE

ignCase

ignWS

newT

fileNs

newModif

keepBraces

keepBrace

ignFilesWith

ignFilesWith2

forward

directory

types

filModEnc

Method Detail

parsePartial

main

doIt