# Uses of Class
org.apache.commons.text.StringSubstitutor

Packages that use StringSubstitutor
Package
Description
org.apache.commons.text
Basic classes for text handling.
org.apache.commons.text.io
`StringSubstitutorReader` is a `Reader` that performs string substitution on a source `Reader` using a `StringSubstitutor`.

- ## Uses of StringSubstitutor in org.apache.commons.text

  Methods in org.apache.commons.text that return StringSubstitutor
  Modifier and Type
  Method
  Description
  `static StringSubstitutor`
  StringSubstitutor.`createInterpolator()`
  Creates a new instance using the interpolator string lookup `StringLookupFactory.interpolatorStringLookup()`.
  `StringSubstitutor`
  StringSubstitutor.`setDisableSubstitutionInValues(boolean disableSubstitutionInValues)`
  Sets a flag whether substitution is done in variable values (recursive).
  `StringSubstitutor`
  StringSubstitutor.`setEnableSubstitutionInVariables(boolean enableSubstitutionInVariables)`
  Sets a flag whether substitution is done in variable names.
  `StringSubstitutor`
  StringSubstitutor.`setEnableUndefinedVariableException(boolean failOnUndefinedVariable)`
  Sets a flag whether exception should be thrown if any variable is undefined.
  `StringSubstitutor`
  StringSubstitutor.`setEscapeChar(char escapeChar)`
  Sets the escape character.
  `StringSubstitutor`
  StringSubstitutor.`setPreserveEscapes(boolean preserveEscapes)`
  Sets a flag controlling whether escapes are preserved during substitution.
  `StringSubstitutor`
  StringSubstitutor.`setValueDelimiter(char valueDelimiter)`
  Sets the variable default value delimiter to use.
  `StringSubstitutor`
  StringSubstitutor.`setValueDelimiter(String valueDelimiter)`
  Sets the variable default value delimiter to use.
  `StringSubstitutor`
  StringSubstitutor.`setValueDelimiterMatcher(StringMatcher valueDelimiterMatcher)`
  Sets the variable default value delimiter matcher to use.
  `StringSubstitutor`
  StringSubstitutor.`setVariablePrefix(char prefix)`
  Sets the variable prefix to use.
  `StringSubstitutor`
  StringSubstitutor.`setVariablePrefix(String prefix)`
  Sets the variable prefix to use.
  `StringSubstitutor`
  StringSubstitutor.`setVariablePrefixMatcher(StringMatcher prefixMatcher)`
  Sets the variable prefix matcher currently in use.
  `StringSubstitutor`
  StringSubstitutor.`setVariableResolver(StringLookup variableResolver)`
  Sets the VariableResolver that is used to lookup variables.
  `StringSubstitutor`
  StringSubstitutor.`setVariableSuffix(char suffix)`
  Sets the variable suffix to use.
  `StringSubstitutor`
  StringSubstitutor.`setVariableSuffix(String suffix)`
  Sets the variable suffix to use.
  `StringSubstitutor`
  StringSubstitutor.`setVariableSuffixMatcher(StringMatcher suffixMatcher)`
  Sets the variable suffix matcher currently in use.
  Constructors in org.apache.commons.text with parameters of type StringSubstitutor
  Modifier
  Constructor
  Description
  ``
  `StringSubstitutor(StringSubstitutor other)`
  Creates a new instance based on the given StringSubstitutor.

- ## Uses of StringSubstitutor in org.apache.commons.text.io

  Constructors in org.apache.commons.text.io with parameters of type StringSubstitutor
  Modifier
  Constructor
  Description
  ``
  `StringSubstitutorReader(Reader reader, StringSubstitutor stringSubstitutor)`
  Constructs a new instance.