Index
All Classes and Interfaces|All Packages
A
- AbstractCodeWriter<T extends AbstractCodeWriter<T>> - Class in software.amazon.smithy.utils
-
Helper class for generating code.
- AbstractCodeWriter() - Constructor for class software.amazon.smithy.utils.AbstractCodeWriter
-
Creates a new SimpleCodeWriter that uses "\n" for a newline, four spaces for indentation, does not strip trailing whitespace, does not flatten multiple successive blank lines into a single blank line, and adds no trailing new line.
- accept(T, U, V) - Method in interface software.amazon.smithy.utils.TriConsumer
-
Performs the operation on the given inputs.
- alwaysTrue() - Static method in class software.amazon.smithy.utils.FunctionalUtils
-
Returns a
Predicatethat always returns true. - andThen(TriConsumer<? super T, ? super U, ? super V>) - Method in interface software.amazon.smithy.utils.TriConsumer
-
Returns a composed
TriConsumerthat performs, in sequence, this operation followed by theafteroperation. - append(W, S) - Method in interface software.amazon.smithy.utils.CodeInterceptor.Appender
-
Writes text after previous content in the section.
- appender(Class<S>, BiConsumer<W, S>) - Static method in interface software.amazon.smithy.utils.CodeInterceptor
-
Provides a more concise way of creating anonymous
CodeInterceptor.Appenders.
B
- br() - Method in class software.amazon.smithy.utils.SimpleParser
-
Skips spaces then expects that the next character is either the end of the expression or a line break (\n, \r\n, or \r).
- build() - Method in interface software.amazon.smithy.utils.SmithyBuilder
-
Creates an immutable object that is created from the properties that have been set on the builder.
- BuilderRef<T> - Interface in software.amazon.smithy.utils
-
Manages the creation, copying, and reuse of values created by builders.
C
- call(Runnable) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Allows calling out to arbitrary code for things like looping or conditional writes without breaking method chaining.
- call(Runnable) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- capitalize(String) - Static method in class software.amazon.smithy.utils.StringUtils
-
Capitalizes a String changing the first character to title case as per
Character.toTitleCase(int). - caseInsensitiveCopyOf(Collection<? extends String>) - Static method in class software.amazon.smithy.utils.SetUtils
- CaseUtils - Class in software.amazon.smithy.utils
-
Provides support for camelCase, snake_case, and other kinds of case conversions.
- clear() - Method in interface software.amazon.smithy.utils.BuilderRef
-
Removes any borrowed or owned values from the reference.
- closeBlock(String, Object...) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Closes a block of syntax by writing a newline, dedenting, then writing text.
- closeBlock(String, Object...) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- CodeInterceptor<S extends CodeSection,
W extends AbstractCodeWriter<W>> - Interface in software.amazon.smithy.utils -
A
CodeSectioninterceptor for a specific type ofCodeSection. - CodeInterceptor.Appender<S extends CodeSection,
W extends AbstractCodeWriter<W>> - Interface in software.amazon.smithy.utils -
A code section interceptor that adds text after the intercepted section.
- CodeInterceptor.Prepender<S extends CodeSection,
W extends AbstractCodeWriter<W>> - Interface in software.amazon.smithy.utils -
A code section interceptor that adds text before the intercepted section.
- CodeSection - Interface in software.amazon.smithy.utils
-
Interface used for strongly typed
AbstractCodeWritersection values. - CodeWriter - Class in software.amazon.smithy.utils
-
Deprecated.
- CodeWriter() - Constructor for class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- CodeWriterDebugInfo - Class in software.amazon.smithy.utils
-
Provides debug information about the current state of a CodeWriter.
- column() - Method in class software.amazon.smithy.utils.SimpleParser
-
Gets the current 1-based column number of the parser.
- consumer(Consumer<T>) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
A simple helper method that makes it easier to invoke the built-in
C(call) formatter using aConsumerwhereTis the specific type ofAbstractCodeWriter. - consumeRemainingCharactersOnLine() - Method in class software.amazon.smithy.utils.SimpleParser
-
Skips over the remaining characters on a line but does not consume the newline character (\n or \r\n).
- consumeUntilNoLongerMatches(Predicate<Character>) - Method in class software.amazon.smithy.utils.SimpleParser
-
Reads a lexeme from the expression while the given
predicatematches each peeked character. - copy() - Method in interface software.amazon.smithy.utils.BuilderRef
-
Creates an immutable copy of
T. - copyOf(Collection<? extends T>) - Static method in class software.amazon.smithy.utils.ListUtils
-
Creates an immutable copy of the given list.
- copyOf(Collection<? extends T>) - Static method in class software.amazon.smithy.utils.SetUtils
-
Creates an immutable copy of the given set.
- copyOf(Map<? extends K, ? extends V>) - Static method in class software.amazon.smithy.utils.MapUtils
-
Creates an immutable copy of the given map.
- copySettingsFrom(AbstractCodeWriter<T>) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Copies settings from the given AbstractCodeWriter into this AbstractCodeWriter.
- copySettingsFrom(CodeWriter) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- createDefault() - Static method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.Creates a default instance of a CodeWriter that uses "\n" for newlines, flattens multiple successive blank lines into a single blank line, and adds a trailing new line if needed when converting the CodeWriter to a string.
D
- decreaseNestingLevel() - Method in class software.amazon.smithy.utils.SimpleParser
-
Decreases the current nesting level of the parser.
- dedent() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Removes one level of indentation from all lines.
- dedent() - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- dedent(int) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Removes a specific number of indentations from all lines.
- dedent(int) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- disableNewlines() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Disables the automatic appending of newlines in the current state.
- disableNewlines() - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
E
- enableNewlines() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Enables the automatic appending of newlines in the current state.
- enableNewlines() - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- enableStackTraceComments(boolean) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Enable or disable writing stack trace comments before each call to
AbstractCodeWriter.write(java.lang.Object, java.lang.Object...),AbstractCodeWriter.writeWithNoFormatting(java.lang.Object),AbstractCodeWriter.writeInline(java.lang.Object, java.lang.Object...), andAbstractCodeWriter.writeInlineWithNoFormatting(java.lang.Object). - ensureNewline() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Ensures that the last text written to the writer was a newline as defined in the current state and inserts one if necessary.
- ensureNewline() - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- entry(K, V) - Static method in class software.amazon.smithy.utils.MapUtils
-
Creates an immutable
Map.Entryfrom the given key and value. - eof() - Method in class software.amazon.smithy.utils.SimpleParser
-
Checks if the parser has reached the end of the expression.
- equals(Object) - Method in class software.amazon.smithy.utils.MediaType
- equals(Object) - Method in class software.amazon.smithy.utils.Pair
- equals(String, String) - Static method in class software.amazon.smithy.utils.StringUtils
-
Compares two Strings, returning
trueif they represent equal sequences of characters. - escapeJavaString(Object, String) - Static method in class software.amazon.smithy.utils.StringUtils
- expect(char) - Method in class software.amazon.smithy.utils.SimpleParser
-
Expects that the next character is the given character and consumes it.
- expect(char...) - Method in class software.amazon.smithy.utils.SimpleParser
-
Expects that the next character is one of a fixed set of possible characters.
- expression() - Method in class software.amazon.smithy.utils.SimpleParser
-
Gets the expression being parsed.
F
- flatMapStream(L, Function<L, Optional<R>>) - Static method in class software.amazon.smithy.utils.Pair
- flatMapStream(L, Supplier<Optional<R>>) - Static method in class software.amazon.smithy.utils.Pair
- forList() - Static method in interface software.amazon.smithy.utils.BuilderRef
-
Creates a builder reference to a list.
- format(Object, Object...) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Creates a formatted string using formatter expressions and variadic arguments.
- formatLiteral(Object) - Static method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Provides the default functionality for formatting literal values.
- formatWithStackTraceElement(String, StackTraceElement, boolean) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Formats content for the given stack frame.
- forName(String) - Static method in interface software.amazon.smithy.utils.CodeSection
-
Creates a CodeSection that returns the given
sectionName. - forName(String, BiConsumer<W, String>) - Static method in interface software.amazon.smithy.utils.CodeInterceptor
-
Creates an interceptor that works with any type of CodeSection and is filtered only by the name of the section.
- forOrderedMap() - Static method in interface software.amazon.smithy.utils.BuilderRef
-
Creates a builder reference to a ordered map.
- forOrderedSet() - Static method in interface software.amazon.smithy.utils.BuilderRef
-
Creates a builder reference to an ordered set.
- forUnorderedMap() - Static method in interface software.amazon.smithy.utils.BuilderRef
-
Creates a builder reference to an unordered map.
- forUnorderedSet() - Static method in interface software.amazon.smithy.utils.BuilderRef
-
Creates a builder reference to an unordered set.
- from(String) - Static method in class software.amazon.smithy.utils.MediaType
-
Create a parsed MediaType from the given string.
- FunctionalUtils - Class in software.amazon.smithy.utils
-
Utilities for working with functions, predicates, etc.
G
- get() - Method in interface software.amazon.smithy.utils.BuilderRef
-
Gets a mutable
Tfrom the reference, creating one if needed. - getContext(String) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Gets a named contextual key-value pair from the current state.
- getContext(String, Class<C>) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Gets a named context key-value pair from the current state and casts the value to the given type.
- getDebugInfo() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Gets debug information about the current state of the AbstractCodeWriter, including the path to the current state as returned by
AbstractCodeWriter.getStateDebugPath(), and up to the last two lines of text written to the AbstractCodeWriter. - getDebugInfo(int) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Gets debug information about the current state of the AbstractCodeWriter.
- getExpressionStart() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Get the expression start character of the current state.
- getIndentLevel() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Gets the indentation level of the current state.
- getIndentText() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Gets the text used for indentation (defaults to four spaces).
- getInsertTrailingNewline() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Checks if the AbstractCodeWriter inserts a trailing newline (if necessary) when converted to a string.
- getKey() - Method in class software.amazon.smithy.utils.Pair
- getLeft() - Method in class software.amazon.smithy.utils.Pair
- getMetadata(String) - Method in class software.amazon.smithy.utils.CodeWriterDebugInfo
-
Gets debug metadata by name.
- getNewline() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Gets the character used to represent newlines in the current state.
- getNewlinePrefix() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Gets the prefix to prepend to every line after a new line is added (except for an inserted trailing newline).
- getParameters() - Method in class software.amazon.smithy.utils.MediaType
-
Gets the immutable map of parameters.
- getRight() - Method in class software.amazon.smithy.utils.Pair
- getStateDebugPath() - Method in class software.amazon.smithy.utils.CodeWriterDebugInfo
-
Get the CodeWriter state path from which the debug information was collected.
- getSubtype() - Method in class software.amazon.smithy.utils.MediaType
-
Gets the "subtype" of the media type.
- getSubtypeWithoutSuffix() - Method in class software.amazon.smithy.utils.MediaType
-
Gets the "subtype" of the media type with no structured syntax suffix.
- getSuffix() - Method in class software.amazon.smithy.utils.MediaType
-
Gets the optional structured syntax suffix.
- getTags() - Method in interface software.amazon.smithy.utils.Tagged
-
Gets the tags applied to an object.
- getTrimBlankLines() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Returns the number of allowed consecutive newlines that are not trimmed by the AbstractCodeWriter when written to a string.
- getTrimTrailingSpaces() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Returns true if the trailing spaces in the current state are trimmed.
- getType() - Method in class software.amazon.smithy.utils.MediaType
-
Gets the "type" of the media type.
- getValue() - Method in class software.amazon.smithy.utils.Pair
H
- hashCode() - Method in class software.amazon.smithy.utils.MediaType
- hashCode() - Method in class software.amazon.smithy.utils.Pair
- hasTag(String) - Method in interface software.amazon.smithy.utils.Tagged
-
Checks if the value has the given tag by name.
- hasValue() - Method in interface software.amazon.smithy.utils.BuilderRef
-
Checks if the reference currently has a borrowed or owned value.
I
- ifPresentOrElse(Optional<T>, Consumer<T>, Runnable) - Static method in class software.amazon.smithy.utils.OptionalUtils
-
Invokes a consumer if the Optional has a value, otherwise invoked a Runnable when the Optional is empty.
- increaseNestingLevel() - Method in class software.amazon.smithy.utils.SimpleParser
-
Increases the current nesting level of the parser.
- indent() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Indents all text one level.
- indent() - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- indent(int) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Indents all text a specific number of levels.
- indent(int) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- injectSection(CodeSection) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Creates a section that contains no content used to allow
CodeInterceptors to inject content at specific locations. - insertTrailingNewline() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Configures the AbstractCodeWriter to always append a newline at the end of the text if one is not already present.
- insertTrailingNewline() - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- insertTrailingNewline(boolean) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Configures the AbstractCodeWriter to always append a newline at the end of the text if one is not already present.
- insertTrailingNewline(boolean) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- IoUtils - Class in software.amazon.smithy.utils
-
Utilities for IO operations.
- isBlank(CharSequence) - Static method in class software.amazon.smithy.utils.StringUtils
-
Checks if a CharSequence is empty (""), null or whitespace only.
- isEmpty(CharSequence) - Static method in class software.amazon.smithy.utils.StringUtils
-
Checks if a CharSequence is empty ("") or null.
- isIntercepted(S) - Method in interface software.amazon.smithy.utils.CodeInterceptor
-
Checks if the given section is filtered by this interceptor or not.
- isJson(String) - Static method in class software.amazon.smithy.utils.MediaType
-
Detects if the given media type string is JSON, meaning it is "application/json" or uses the "+json" structured syntax suffix.
- isNotBlank(CharSequence) - Static method in class software.amazon.smithy.utils.StringUtils
-
Checks if a CharSequence is not empty (""), not null and not whitespace only.
- isStackTraceRelevant(StackTraceElement) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Tests if the given
StackTraceElementis relevant for a comment used when writing debug information before calls to write.
L
- left - Variable in class software.amazon.smithy.utils.Pair
- leftPad(String, int) - Static method in class software.amazon.smithy.utils.StringUtils
-
Left pad a String with spaces (' ').
- leftPad(String, int, char) - Static method in class software.amazon.smithy.utils.StringUtils
-
Left pad a String with a specified character.
- leftPad(String, int, String) - Static method in class software.amazon.smithy.utils.StringUtils
-
Left pad a String with a specified String.
- levenshteinDistance(CharSequence, CharSequence, int) - Static method in class software.amazon.smithy.utils.StringUtils
-
Find the Levenshtein distance between two CharSequences if it's less than or equal to a given threshold.
- line() - Method in class software.amazon.smithy.utils.SimpleParser
-
Gets the current 1-based line number of the parser.
- ListUtils - Class in software.amazon.smithy.utils
-
Immutable List utilities to polyfill Java 9+ features.
- lowerCase(String) - Static method in class software.amazon.smithy.utils.StringUtils
-
Converts a String to lower case as per
String.toLowerCase().
M
- MapUtils - Class in software.amazon.smithy.utils
-
Immutable Map utilities to polyfill Java 9+ features.
- MediaType - Class in software.amazon.smithy.utils
-
Implements a simple media type parser based on the Content-Type grammar defined in RFC 7231.
N
- nestingLevel() - Method in class software.amazon.smithy.utils.SimpleParser
-
Gets the current 0-based nesting level of the parser.
- not(Predicate<T>) - Static method in class software.amazon.smithy.utils.FunctionalUtils
-
Negates a
Predicate.
O
- of() - Static method in class software.amazon.smithy.utils.ListUtils
-
Returns an unmodifiable list containing zero entries.
- of() - Static method in class software.amazon.smithy.utils.MapUtils
-
Returns an unmodifiable map containing zero mappings.
- of() - Static method in class software.amazon.smithy.utils.SetUtils
-
Returns an unmodifiable set containing zero entries.
- of(K, V) - Static method in class software.amazon.smithy.utils.MapUtils
-
Returns an unmodifiable map containing a single mapping.
- of(K, V, K, V) - Static method in class software.amazon.smithy.utils.MapUtils
-
Returns an unmodifiable map containing two mappings.
- of(K, V, K, V, K, V) - Static method in class software.amazon.smithy.utils.MapUtils
-
Returns an unmodifiable map containing three mappings.
- of(K, V, K, V, K, V, K, V) - Static method in class software.amazon.smithy.utils.MapUtils
-
Returns an unmodifiable map containing four mappings.
- of(K, V, K, V, K, V, K, V, K, V) - Static method in class software.amazon.smithy.utils.MapUtils
-
Returns an unmodifiable map containing five mappings.
- of(K, V, K, V, K, V, K, V, K, V, K, V) - Static method in class software.amazon.smithy.utils.MapUtils
-
Returns an unmodifiable map containing six mappings.
- of(K, V, K, V, K, V, K, V, K, V, K, V, K, V) - Static method in class software.amazon.smithy.utils.MapUtils
-
Returns an unmodifiable map containing seven mappings.
- of(K, V, K, V, K, V, K, V, K, V, K, V, K, V, K, V) - Static method in class software.amazon.smithy.utils.MapUtils
-
Returns an unmodifiable map containing eight mappings.
- of(K, V, K, V, K, V, K, V, K, V, K, V, K, V, K, V, K, V) - Static method in class software.amazon.smithy.utils.MapUtils
-
Returns an unmodifiable map containing nine mappings.
- of(K, V, K, V, K, V, K, V, K, V, K, V, K, V, K, V, K, V, K, V) - Static method in class software.amazon.smithy.utils.MapUtils
-
Returns an unmodifiable map containing ten mappings.
- of(L, R) - Static method in class software.amazon.smithy.utils.Pair
-
Creates a Pair from the given values.
- of(T) - Static method in class software.amazon.smithy.utils.ListUtils
-
Returns an unmodifiable list containing a single entry.
- of(T) - Static method in class software.amazon.smithy.utils.SetUtils
-
Returns an unmodifiable set containing a single entry.
- of(T...) - Static method in class software.amazon.smithy.utils.ListUtils
-
Returns an unmodifiable list containing any number of entries.
- of(T...) - Static method in class software.amazon.smithy.utils.SetUtils
-
Returns an unmodifiable set containing any number of entries.
- of(T, T) - Static method in class software.amazon.smithy.utils.ListUtils
-
Returns an unmodifiable list containing two entries.
- ofEntries(Map.Entry<? extends K, ? extends V>...) - Static method in class software.amazon.smithy.utils.MapUtils
-
Creates an unmodifiable Map from an array of
Map.Entryvalues. - onSection(String, Consumer<Object>) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Registers a function that intercepts the contents of a section and writes to the
AbstractCodeWriterwith the updated contents. - onSection(String, Consumer<Object>) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- onSection(CodeInterceptor<S, T>) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Intercepts a section of code emitted for a strongly typed
CodeSection. - onSectionAppend(String, Runnable) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- onSectionPrepend(String, Runnable) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- openBlock(String, Object...) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Opens a block of syntax by writing text, a newline, then indenting.
- openBlock(String, Object...) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- openBlock(String, String, Object[], Runnable) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Opens a block of syntax by writing
textBeforeNewline, a newline, then indenting, then executes the givenRunnable, then closes the block of syntax by writing a newline, dedenting, then writingtextAfterNewline. - openBlock(String, String, Object[], Runnable) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- openBlock(String, String, Object, Object, Object, Object, Object, Runnable) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Opens a block of syntax by writing
textBeforeNewline, a newline, then indenting, then executes the givenRunnable, then closes the block of syntax by writing a newline, dedenting, then writingtextAfterNewline. - openBlock(String, String, Object, Object, Object, Object, Object, Runnable) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- openBlock(String, String, Object, Object, Object, Object, Runnable) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Opens a block of syntax by writing
textBeforeNewline, a newline, then indenting, then executes the givenRunnable, then closes the block of syntax by writing a newline, dedenting, then writingtextAfterNewline. - openBlock(String, String, Object, Object, Object, Object, Runnable) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- openBlock(String, String, Object, Object, Object, Runnable) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Opens a block of syntax by writing
textBeforeNewline, a newline, then indenting, then executes the givenRunnable, then closes the block of syntax by writing a newline, dedenting, then writingtextAfterNewline. - openBlock(String, String, Object, Object, Object, Runnable) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- openBlock(String, String, Object, Object, Runnable) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Opens a block of syntax by writing
textBeforeNewline, a newline, then indenting, then executes the givenRunnable, then closes the block of syntax by writing a newline, dedenting, then writingtextAfterNewline. - openBlock(String, String, Object, Object, Runnable) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- openBlock(String, String, Object, Runnable) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Opens a block of syntax by writing
textBeforeNewline, a newline, then indenting, then executes the givenRunnable, then closes the block of syntax by writing a newline, dedenting, then writingtextAfterNewline. - openBlock(String, String, Object, Runnable) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- openBlock(String, String, Runnable) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Opens a block of syntax by writing
textBeforeNewline, a newline, then indenting, then executes the givenRunnable, then closes the block of syntax by writing a newline, dedenting, then writingtextAfterNewline. - openBlock(String, String, Runnable) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- OptionalUtils - Class in software.amazon.smithy.utils
-
Functions that make working with optionals easier.
- or(Optional<T>, Supplier<Optional<? extends T>>) - Static method in class software.amazon.smithy.utils.OptionalUtils
-
Retrieves the value of the optional if present or invokes the supplier for a value.
- orderedCopyOf(Collection<? extends T>) - Static method in class software.amazon.smithy.utils.SetUtils
-
Creates an ordered immutable copy of the given set.
- orderedCopyOf(Map<? extends K, ? extends V>) - Static method in class software.amazon.smithy.utils.MapUtils
-
Creates an ordered immutable copy of the given map.
P
- Pair<L,
R> - Class in software.amazon.smithy.utils -
Generic immutable pair of values.
- Pair(L, R) - Constructor for class software.amazon.smithy.utils.Pair
- peek() - Method in interface software.amazon.smithy.utils.BuilderRef
-
Gets an immutable
Tfrom the reference, reusing borrowed values if possible, and creating owned values if needed. - peek() - Method in class software.amazon.smithy.utils.SimpleParser
-
Returns the current character of the expression, but does not consume it.
- peek(int) - Method in class software.amazon.smithy.utils.SimpleParser
-
Returns the current character of the expression +
offsetcharacters, but does not consume it. - peekSingleCharForMessage() - Method in class software.amazon.smithy.utils.SimpleParser
-
Peeks the next character and returns [EOF] if the next character is past the end of the expression.
- popState() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Pops the current AbstractCodeWriter state from the state stack.
- popState() - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- position() - Method in class software.amazon.smithy.utils.SimpleParser
-
Gets the current 0-based position of the parser.
- prepend(W, S) - Method in interface software.amazon.smithy.utils.CodeInterceptor.Prepender
-
Writes text before previously written content in the section.
- pushFilteredState(Function<String, String>) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Pushes an anonymous named state that is always passed through the given filter function before being written to the writer.
- pushFilteredState(Function<String, String>) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- pushState() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Copies and pushes the current state to the state stack.
- pushState() - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- pushState(String) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Copies and pushes the current state to the state stack using a named state that can be intercepted by functions registered with
AbstractCodeWriter.onSection(CodeInterceptor). - pushState(String) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- pushState(CodeSection) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Pushes a strongly typed section extension point.
- putContext(String, Object) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Adds a named key-value pair to the context of the current state.
- putContext(String, Object) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- putContext(Map<String, Object>) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Adds a map of named key-value pair to the context of the current state.
- putContext(Map<String, Object>) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- putFormatter(char, BiFunction<Object, String, String>) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Adds a custom formatter expression to the current state of the
AbstractCodeWriter. - putFormatter(char, BiFunction<Object, String, String>) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- putMetadata(String, String) - Method in class software.amazon.smithy.utils.CodeWriterDebugInfo
-
Put additional debug metadata on the object.
R
- readUtf8File(String) - Static method in class software.amazon.smithy.utils.IoUtils
-
Reads a file into a UTF-8 encoded string.
- readUtf8File(Path) - Static method in class software.amazon.smithy.utils.IoUtils
-
Reads a file into a UTF-8 encoded string.
- readUtf8Resource(Class<?>, String) - Static method in class software.amazon.smithy.utils.IoUtils
-
Reads a class resource into a UTF-8 string.
- readUtf8Resource(ClassLoader, String) - Static method in class software.amazon.smithy.utils.IoUtils
-
Reads a class loader resource into a UTF-8 string.
- readUtf8Url(URL) - Static method in class software.amazon.smithy.utils.IoUtils
-
Reads a URL resource into a UTF-8 string.
- removeContext(String) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Removes a named key-value pair from the context of the current state.
- removeContext(String) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- repeat(char, int) - Static method in class software.amazon.smithy.utils.StringUtils
-
Returns padding using the specified delimiter repeated to a given length.
- repeat(String, int) - Static method in class software.amazon.smithy.utils.StringUtils
-
Repeat a String
repeattimes to form a new String. - requiredState(String, T) - Static method in interface software.amazon.smithy.utils.SmithyBuilder
-
Convenience method for ensuring that a value was set on a builder, and if not, throws an IllegalStateException with a useful message.
- rewind(int, int, int) - Method in class software.amazon.smithy.utils.SimpleParser
- right - Variable in class software.amazon.smithy.utils.Pair
- rightPad(String, int) - Static method in class software.amazon.smithy.utils.StringUtils
-
Right pad a String with spaces (' ').
- rightPad(String, int, char) - Static method in class software.amazon.smithy.utils.StringUtils
-
Right pad a String with a specified character.
- rightPad(String, int, String) - Static method in class software.amazon.smithy.utils.StringUtils
-
Right pad a String with a specified String.
- rmdir(Path) - Static method in class software.amazon.smithy.utils.IoUtils
-
Delete a directory and all files within.
- runCommand(String) - Static method in class software.amazon.smithy.utils.IoUtils
-
Runs a process using the given
commandat the current directory specified bySystem.getProperty("user.dir"). - runCommand(String, Path) - Static method in class software.amazon.smithy.utils.IoUtils
-
Runs a process using the given
commandrelative to the givendirectory. - runCommand(String, Path, Appendable) - Static method in class software.amazon.smithy.utils.IoUtils
-
Runs a process using the given
commandrelative to the givendirectoryand writes stdout and stderr tooutput. - runCommand(String, Path, Appendable, Map<String, String>) - Static method in class software.amazon.smithy.utils.IoUtils
-
Runs a process using the given
commandrelative to the givendirectoryand writes stdout and stderr tooutput. - runCommand(List<String>, Path, Appendable, Map<String, String>) - Static method in class software.amazon.smithy.utils.IoUtils
-
Runs a process using the given
commandrelative to the givendirectoryand writes stdout and stderr tooutput.
S
- sectionName() - Method in interface software.amazon.smithy.utils.CodeSection
-
Gets the name of the section.
- sectionType() - Method in interface software.amazon.smithy.utils.CodeInterceptor
-
Get the strongly typed
CodeSectionthis interceptor is used to intercept. - setExpressionStart(char) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Sets the character used to start expressions in the current state when calling
AbstractCodeWriter.write(java.lang.Object, java.lang.Object...),AbstractCodeWriter.writeInline(java.lang.Object, java.lang.Object...),AbstractCodeWriter.openBlock(java.lang.String, java.lang.Object...), etc. - setExpressionStart(char) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- setIndentText(String) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Sets the text used for indentation (defaults to four spaces).
- setIndentText(String) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- setNewline(char) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Sets the character used to represent newlines in the current state ("\n" is the default).
- setNewline(char) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- setNewline(String) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Sets the character used to represent newlines in the current state ("\n" is the default).
- setNewline(String) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- setNewlinePrefix(String) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Sets a prefix to prepend to every line after a new line is added (except for an inserted trailing newline).
- setNewlinePrefix(String) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- SetUtils - Class in software.amazon.smithy.utils
-
Immutable Set utilities to polyfill Java 9+ features.
- setValue(R) - Method in class software.amazon.smithy.utils.Pair
- SimpleCodeWriter - Class in software.amazon.smithy.utils
-
Helper class for generating code.
- SimpleCodeWriter() - Constructor for class software.amazon.smithy.utils.SimpleCodeWriter
- SimpleParser - Class in software.amazon.smithy.utils
-
A simple expression parser that can be extended to implement parsers for small domain specific languages.
- SimpleParser(String) - Constructor for class software.amazon.smithy.utils.SimpleParser
-
Creates a new SimpleParser and sets the expression to parse.
- SimpleParser(String, int) - Constructor for class software.amazon.smithy.utils.SimpleParser
-
Creates a new SimpleParser and sets the expression to parse.
- skip() - Method in class software.amazon.smithy.utils.SimpleParser
-
Skips a single character while tracking lines and columns.
- sliceFrom(int) - Method in class software.amazon.smithy.utils.SimpleParser
-
Gets a slice of the expression starting from the given 0-based character position, read all the way through to the current position of the parser.
- SmithyBuilder<T> - Interface in software.amazon.smithy.utils
-
A mutable object that can be used to create an immutable object of type T.
- SmithyGenerated - Annotation Interface in software.amazon.smithy.utils
-
Annotation used to indicate that a package or class was generated and should not be edited directly.
- SmithyInternalApi - Annotation Interface in software.amazon.smithy.utils
-
Annotation used to indicate that an API is considered internal to Smithy and subject to change.
- SmithyUnstableApi - Annotation Interface in software.amazon.smithy.utils
-
Annotation used to indicate that an API is considered unstable and subject to change.
- snakeToCamelCase(String) - Static method in class software.amazon.smithy.utils.CaseUtils
-
Converts all the delimiter separated words in a String into camelCase, that is each word is made up of a titlecase character and then a series of lowercase characters.
- snakeToPascalCase(String) - Static method in class software.amazon.smithy.utils.CaseUtils
-
Converts all words separated by "_" into PascalCase, that is each word is made up of a titlecase character and then a series of lowercase characters.
- software.amazon.smithy.utils - package software.amazon.smithy.utils
- sp() - Method in class software.amazon.smithy.utils.SimpleParser
-
Skip 0 or more spaces (that is, ' ' and '\t').
- startsWithIgnoreCase(String, String) - Static method in class software.amazon.smithy.utils.StringUtils
-
Tests if this string starts with the specified prefix ignoring case considerations.
- stream(Optional<T>) - Static method in class software.amazon.smithy.utils.OptionalUtils
-
Converts an Optional into a Stream that can be used in a flatmap.
- StringUtils - Class in software.amazon.smithy.utils
-
Operations on
Stringthat arenullsafe. - strip(String, String) - Static method in class software.amazon.smithy.utils.StringUtils
-
Strips any of a set of characters from the start and end of a String.
- stripEnd(String, String) - Static method in class software.amazon.smithy.utils.StringUtils
-
Strips any of a set of characters from the end of a String.
- stripStart(String, String) - Static method in class software.amazon.smithy.utils.StringUtils
-
Strips any of a set of characters from the start of a String.
- stripToEmpty(String) - Static method in class software.amazon.smithy.utils.StringUtils
-
Strips whitespace from the start and end of a String returning an empty String if
nullinput. - substring(String, int) - Static method in class software.amazon.smithy.utils.StringUtils
-
Gets a substring from the specified String avoiding exceptions.
- substring(String, int, int) - Static method in class software.amazon.smithy.utils.StringUtils
-
Gets a substring from the specified String avoiding exceptions.
- syntax(String) - Method in class software.amazon.smithy.utils.SimpleParser
-
Creates a syntax error that adds some context to the given message.
T
- Tagged - Interface in software.amazon.smithy.utils
-
A type that contains tags.
- toBuilder() - Method in interface software.amazon.smithy.utils.ToSmithyBuilder
-
Take this object and create a builder that contains all of the current property values of this object.
- toByteArray(InputStream) - Static method in class software.amazon.smithy.utils.IoUtils
-
Reads and returns the rest of the given input stream as a byte array.
- toCamelCase(String) - Static method in class software.amazon.smithy.utils.CaseUtils
-
Converts all words separated by " ", "-", and "_" to CamelCase.
- toCamelCase(String, boolean, char...) - Static method in class software.amazon.smithy.utils.CaseUtils
-
Converts all the delimiter separated words in a String into camelCase, that is each word is made up of a titlecase character and then a series of lowercase characters.
- toPascalCase(String) - Static method in class software.amazon.smithy.utils.CaseUtils
-
Converts all words separated by " ", "-", and "_" to CamelCase.
- ToSmithyBuilder<T> - Interface in software.amazon.smithy.utils
-
Provides a way to get from an instance of T to a
SmithyBuilder. - toSnakeCase(String) - Static method in class software.amazon.smithy.utils.CaseUtils
-
Convert a given word to snake_case with all lowercase letters.
- toString() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Gets the contents of the generated code.
- toString() - Method in class software.amazon.smithy.utils.CodeWriterDebugInfo
-
Returns a string representation that can be used in exception messages and when debugging.
- toString() - Method in class software.amazon.smithy.utils.MediaType
- toString() - Method in class software.amazon.smithy.utils.Pair
- toUnmodifiableList() - Static method in class software.amazon.smithy.utils.ListUtils
-
Creates a collector that collects into an unmodifiable list.
- toUnmodifiableMap(Function<? super T, ? extends K>, Function<? super T, ? extends U>) - Static method in class software.amazon.smithy.utils.MapUtils
-
Creates a collector that collects into an unmodifiable Map.
- toUnmodifiableSet() - Static method in class software.amazon.smithy.utils.SetUtils
-
Creates a collector that collects into an unmodifiable set.
- toUtf8String(InputStream) - Static method in class software.amazon.smithy.utils.IoUtils
-
Reads and returns the rest of the given input stream as a string.
- TriConsumer<T,
U, V> - Interface in software.amazon.smithy.utils -
Similar to
BiConsumer, but accepts three arguments. - trim(String) - Static method in class software.amazon.smithy.utils.StringUtils
-
Removes control characters (char <= 32) from both ends of this String, handling
nullby returningnull. - trimBlankLines() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Ensures that no more than one blank line occurs in succession.
- trimBlankLines() - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- trimBlankLines(int) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Ensures that no more than the given number of newlines can occur in succession, removing consecutive newlines that exceed the given threshold.
- trimBlankLines(int) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- trimToEmpty(String) - Static method in class software.amazon.smithy.utils.StringUtils
-
Removes control characters (char <= 32) from both ends of this String returning an empty String ("") if the String is empty ("") after the trim or if it is
null. - trimToNull(String) - Static method in class software.amazon.smithy.utils.StringUtils
-
Removes control characters (char <= 32) from both ends of this String returning
nullif the String is empty ("") after the trim or if it isnull. - trimTrailingSpaces() - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Enables the trimming of trailing spaces on a line.
- trimTrailingSpaces() - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- trimTrailingSpaces(boolean) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Configures if trailing spaces on a line are removed.
- trimTrailingSpaces(boolean) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
U
- uncapitalize(String) - Static method in class software.amazon.smithy.utils.StringUtils
-
Uncapitalizes a String, changing the first character to lower case as per
Character.toLowerCase(int). - unwrite(Object, Object...) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Remove the most recent text written to the AbstractCodeWriter if and only if the last written text is exactly equal to the given expanded content string.
- unwrite(Object, Object...) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- upperCase(String) - Static method in class software.amazon.smithy.utils.StringUtils
-
Converts a String to upper case as per
String.toUpperCase().
W
- wrap(String, int) - Static method in class software.amazon.smithy.utils.StringUtils
-
Wraps a single line of text, identifying words by
' '. - wrap(String, int, String, boolean) - Static method in class software.amazon.smithy.utils.StringUtils
-
Wraps a single line of text, identifying words by
' '. - wrap(String, int, String, boolean, String) - Static method in class software.amazon.smithy.utils.StringUtils
-
Wraps a single line of text, identifying words by
wrapOn. - write(Object, Object...) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Writes text to the AbstractCodeWriter and appends a newline.
- write(Object, Object...) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- write(W, String, S) - Method in interface software.amazon.smithy.utils.CodeInterceptor.Appender
- write(W, String, S) - Method in interface software.amazon.smithy.utils.CodeInterceptor.Prepender
- write(W, String, S) - Method in interface software.amazon.smithy.utils.CodeInterceptor
-
Intercepts an
AbstractCodeWritersection. - writeInline(Object, Object...) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Writes text to the AbstractCodeWriter without appending a newline.
- writeInline(Object, Object...) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- writeInlineWithNoFormatting(Object) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Writes inline text to the AbstractCodeWriter with no formatting.
- writeOptional(Object) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Optionally writes text to the AbstractCodeWriter and appends a newline if a value is present.
- writeOptional(Object) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- writeWithNoFormatting(Object) - Method in class software.amazon.smithy.utils.AbstractCodeWriter
-
Writes text to the AbstractCodeWriter and appends a newline.
- writeWithNoFormatting(Object) - Method in class software.amazon.smithy.utils.CodeWriter
-
Deprecated.
- ws() - Method in class software.amazon.smithy.utils.SimpleParser
-
Skip 0 or more whitespace characters (that is, ' ', '\t', '\r', and '\n').
All Classes and Interfaces|All Packages
SimpleCodeWriteror a custom subclass ofAbstractCodeWriter.