Package software.amazon.smithy.codegen.core

Class ReservedWordsBuilder

java.lang.Object
software.amazon.smithy.codegen.core.ReservedWordsBuilder
public final class ReservedWordsBuilder extends Object
Builds a ReservedWords implementation from explicit mappings and from line-delimited files that contain reserved words.

  • Constructor Details

    • ReservedWordsBuilder

      public ReservedWordsBuilder()

  • Method Details

    • build

      public ReservedWords build()
      Builds the reserved words.
      Returns:
      Returns the created reserved words implementation.

    • put

      public ReservedWordsBuilder put(String reservedWord, String conversion)
      Add a new reserved words.
      Parameters:
      reservedWord - Reserved word to convert.
      conversion - Word to convert to.
      Returns:
      Returns the builder.

    • loadWords

      public ReservedWordsBuilder loadWords(URL location)
      Load a list of case-sensitive, line-delimited reserved words from a file.

      This method will escape words by prefixing them with "_". Use loadWords(URL, Function) to customize how words are escaped.

      Blank lines and lines that start with # are ignored.

      Parameters:
      location - URL of the file to load.
      Returns:
      Returns the builder.

    • loadWords

      public ReservedWordsBuilder loadWords(URL location, Function<String,String> escaper)
      Load a list of case-sensitive, line-delimited reserved words from a file.

      Blank lines and lines that start with # are ignored.

      Parameters:
      location - URL of the file to load.
      escaper - Function used to escape reserved words.
      Returns:
      Returns the builder.

    • loadCaseInsensitiveWords

      public ReservedWordsBuilder loadCaseInsensitiveWords(URL location)
      Load a list of case-insensitive, line-delimited reserved words from a file.

      This method will escape words by prefixing them with "_". Use loadCaseInsensitiveWords(URL, Function) to customize how words are escaped.

      Blank lines and lines that start with # are ignored.

      Parameters:
      location - URL of the file to load.
      Returns:
      Returns the builder.

    • loadCaseInsensitiveWords

      public ReservedWordsBuilder loadCaseInsensitiveWords(URL location, Function<String,String> escaper)
      Load a list of case-insensitive, line-delimited reserved words from a file.

      Blank lines and lines that start with # are ignored.

      Parameters:
      location - URL of the file to load.
      escaper - Function used to escape reserved words.
      Returns:
      Returns the builder.