Name

adams.flow.transformer.StringReplace

Synopsis

Performs a string replacement, using either String.replaceFirst(...) or String.replaceAll(...). Special characters like \n \r \t and \ need to be escaped properly. The input is expected to be escaped, i.e., the string "\t" will get turned into the character '\t'.
If the 'replace' string contains both, variables and placeholders, then first all variables are expanded and then the placeholders. This ensures that variables containing placeholders expand their placeholders as well. Not expanding placeholders will cause 'Illegal group reference' error messages.
If no regular expression matching is required, you can also use the simple replacing, which uses String.replace(...).

Additional information

Flow input/output:
- input: java.lang.String, java.lang.String[]
- output: java.lang.String, java.lang.String[]

Options

• loggingLevel
  

  The logging level for outputting errors and debugging output.

  command-line	-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST>
  default	WARNING
  min-user-mode	Expert

  
  
• name
  

  The name of the actor.

  command-line	-name <java.lang.String>
  default	StringReplace

  
  
• annotations
  

  The annotations to attach to this actor.

  command-line	-annotation <adams.core.base.BaseAnnotation>
  default

  
  
• skip
  

  If set to true, transformation is skipped and the input token is just forwarded as it is.

  command-line	-skip <boolean>
  default	false

  
  
• stopFlowOnError
  

  If set to true, the flow execution at this level gets stopped in case this actor encounters an error; the error gets propagated; useful for critical actors.

  command-line	-stop-flow-on-error <boolean>
  default	false
  min-user-mode	Expert

  
  
• silent
  

  If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well.

  command-line	-silent <boolean>
  default	false
  min-user-mode	Expert

  
  
• find
  

  The string to find (a regular expression).

  command-line	-find <adams.core.base.BaseRegExp>
  default	find
  more	https://docs.oracle.com/javase/tutorial/essential/regex/
  	https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html

  
  
• replace
  

  The string to replace the occurrences with.

  command-line	-replace <java.lang.String>
  default

  
  
• replaceType
  

  Defines whether to use regular expression replacement (first/all) or simple string sequence replacement.

  command-line	-type <FIRST|ALL|SIMPLE>
  default	FIRST

  
  
• replaceContainsPlaceholder
  

  Set this to true to enable automatic placeholder expansion for the replacement string.

  command-line	-placeholder <boolean>
  default	false

  
  
• replaceContainsVariable
  

  Set this to true to enable automatic variable expansion for the replacement string.

  command-line	-variable <boolean>
  default	false