software.amazon.smithy.codegen.core

Class ReservedWordsBuilder

java.lang.Object

software.amazon.smithy.codegen.core.ReservedWordsBuilder

public final class ReservedWordsBuilder
extends java.lang.Object

Builds a ReservedWords implementation from explicit mappings and from line-delimited files that contain reserved words.

Constructor Summary

Constructors

Constructor and Description
ReservedWordsBuilder()

Method Summary

Modifier and Type	Method and Description
ReservedWords	build() Builds the reserved words.
ReservedWordsBuilder	loadCaseInsensitiveWords(java.net.URL location) Load a list of case-insensitive, line-delimited reserved words from a file.
ReservedWordsBuilder	loadCaseInsensitiveWords(java.net.URL location, java.util.function.Function<java.lang.String,java.lang.String> escaper) Load a list of case-insensitive, line-delimited reserved words from a file.
ReservedWordsBuilder	loadWords(java.net.URL location) Load a list of case-sensitive, line-delimited reserved words from a file.
ReservedWordsBuilder	loadWords(java.net.URL location, java.util.function.Function<java.lang.String,java.lang.String> escaper) Load a list of case-sensitive, line-delimited reserved words from a file.
ReservedWordsBuilder	put(java.lang.String reservedWord, java.lang.String conversion) Add a new reserved words.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReservedWordsBuilder

public ReservedWordsBuilder()

Method Detail

build

public ReservedWords build()

Builds the reserved words.

Returns:

Returns the created reserved words implementation.

put

public ReservedWordsBuilder put(java.lang.String reservedWord,
                                java.lang.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(java.net.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(java.net.URL location,
                                      java.util.function.Function<java.lang.String,java.lang.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(java.net.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(java.net.URL location,
                                                     java.util.function.Function<java.lang.String,java.lang.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.