Interface SubstitutionMap

All Known Subinterfaces:
MultipleMappingSubstitutionMap, SubstitutionMap.Initializable
All Known Implementing Classes:
IdentitySubstitutionMap, MinimalSubstitutionMap, PrefixingSubstitutionMap, RecordingSubstitutionMap, SimpleSplittingSubstitutionMap, SimpleSubstitutionMap, SplittingSubstitutionMap

public interface SubstitutionMap
An interface for a one-to-one string mapping function.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    A substitution map that can be reconsitituted from saved mappings.
  • Method Summary

    Modifier and Type
    Method
    Description
    get(String key)
    Gets the string that should be substituted for key.
  • Method Details

    • get

      String get(String key)
      Gets the string that should be substituted for key. The same value must be consistently returned for any particular key, and the returned value must not be returned for any other key value.
      Parameters:
      key - the text to be replaced (never null)
      Returns:
      the value to substitute for key