Package 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 Object implements SmithyBuilder<SymbolReference>
Builds a SymbolReference.

  • Method Details

    • 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(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(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 SymbolReference.Builder putProperty(String key, Object value)
      Sets a specific custom property.
      Parameters:
      key - Key to set.
      value - Value to set.
      Returns:
      Returns the builder.

    • putProperty

      public <K> SymbolReference.Builder putProperty(Property<K> property, K value)
      Sets a specific, typed custom property.
      Parameters:
      property - Key to set.
      value - Value to set.
      Returns:
      Returns the builder.

    • removeProperty

      public SymbolReference.Builder removeProperty(String key)
      Removes a specific custom property.
      Parameters:
      key - Key to remove.
      Returns:
      Returns the builder.

    • removeProperty

      public SymbolReference.Builder removeProperty(Property<?> property)
      Removes a specific, typed custom property.
      Parameters:
      property - Property to remove.
      Returns:
      Returns the builder.

    • properties

      public SymbolReference.Builder properties(Map<String,Object> properties)
      Replaces all the custom properties.
      Parameters:
      properties - Custom properties to replace with.
      Returns:
      Returns the builder.

    • typedProperties

      public SymbolReference.Builder typedProperties(Map<Property<?>,Object> properties)
      Replaces all the custom typed properties.
      Parameters:
      properties - Custom typed properties to replace with.
      Returns:
      Returns the builder.