software.amazon.smithy.codegen.core

Class SymbolReference.Builder

java.lang.Object

software.amazon.smithy.codegen.core.SymbolReference.Builder

All Implemented Interfaces:

SmithyBuilder<SymbolReference>

Enclosing class:

SymbolReference

public static final class SymbolReference.Builder
extends java.lang.Object
implements SmithyBuilder<SymbolReference>

Builds a SymbolReference.

Method Summary

Modifier and Type	Method and Description
SymbolReference.Builder	alias(java.lang.String alias) Adds an alias to the SymbolReference.
SymbolReference	build() Creates an immutable object that is created from the properties that have been set on the builder.
SymbolReference.Builder	options(java.util.Set<SymbolReference.Option> options) Replaces the Set of Options to the SymbolReference.
SymbolReference.Builder	options(SymbolReference.Option... options) Replaces the array of Options in the SymbolReference.
T	properties(java.util.Map<java.lang.String,java.lang.Object> properties) Replaces all of the custom properties.
T	putProperty(java.lang.String key, java.lang.Object value) Sets a specific custom property.
T	removeProperty(java.lang.String key) Removes a specific custom property.
SymbolReference.Builder	symbol(Symbol symbol) Sets the Symbol referenced by the SymbolReference.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.smithy.utils.SmithyBuilder

requiredState

Method Detail

build

public SymbolReference build()

Description copied from interface: SmithyBuilder

Creates an immutable object that is created from the properties that have been set on the builder.

Specified by:

build in interface SmithyBuilder<SymbolReference>

Returns:

an instance of T

symbol

public SymbolReference.Builder symbol(Symbol symbol)

Sets the Symbol referenced by the SymbolReference.

Parameters:

symbol - Symbol to reference.

Returns:

Returns the builder.

options

public SymbolReference.Builder options(java.util.Set<SymbolReference.Option> options)

Replaces the Set of Options to the SymbolReference.

Parameters:

options - Options to add.

Returns:

Returns the builder.

options

public SymbolReference.Builder options(SymbolReference.Option... options)

Replaces the array of Options in the SymbolReference.

Parameters:

options - Options to add.

Returns:

Returns the builder.

alias

public SymbolReference.Builder alias(java.lang.String alias)

Adds an alias to the SymbolReference.

An alias is used in some programming languages to change the way a symbol is referenced in a source file. Aliases are often used for de-conflicting symbols.

Parameters:

alias - Alias to assign the symbol.

Returns:

Returns the builder.

putProperty

public T putProperty(java.lang.String key,
                     java.lang.Object value)

Sets a specific custom property.

Parameters:

key - Key to set.

value - Value to set.

Returns:

Returns the builder.

removeProperty

public T removeProperty(java.lang.String key)

Removes a specific custom property.

Parameters:

key - Key to remove.

Returns:

Returns the builder.

properties

public T properties(java.util.Map<java.lang.String,java.lang.Object> properties)

Replaces all of the custom properties.

Parameters:

properties - Custom properties to replace with.

Returns:

Returns the builder.