Package software.amazon.smithy.codegen.core

Class SymbolDependency.Builder

java.lang.Object

software.amazon.smithy.codegen.core.SymbolDependency.Builder

All Implemented Interfaces:

SmithyBuilder<SymbolDependency>

Enclosing class:

SymbolDependency

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

Builds a SymbolDependency.

Method Summary

Modifier and Type	Method	Description
SymbolDependency	build()	Creates an immutable object that is created from the properties that have been set on the builder.
SymbolDependency.Builder	dependencyType(java.lang.String dependencyType)	Sets the type of dependency (for example, "dev", "optional", etc).
SymbolDependency.Builder	packageName(java.lang.String packageName)	Sets the package name of the dependency.
T	properties(java.util.Map<java.lang.String,java.lang.Object> properties)	Replaces all the custom properties.
T	putProperty(java.lang.String key, java.lang.Object value)	Sets a specific custom property.
<K> T	putProperty(Property<K> property, K value)	Sets a specific, typed custom property.
T	removeProperty(java.lang.String key)	Removes a specific custom property.
T	removeProperty(Property<?> property)	Removes a specific, typed custom property.
T	typedProperties(java.util.Map<Property<?>,java.lang.Object> properties)	Replaces all the custom typed properties.
SymbolDependency.Builder	version(java.lang.String version)	Sets the version string of the dependency.

Methods inherited from class java.lang.Object

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

Method Detail

build

public SymbolDependency 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<SymbolDependency>

Returns:

an instance of T

dependencyType

public SymbolDependency.Builder dependencyType(java.lang.String dependencyType)

Sets the type of dependency (for example, "dev", "optional", etc).

Defaults to an empty string if not explicitly set.

Parameters:

dependencyType - Dependency type to set.

Returns:

Returns the builder.

packageName

public SymbolDependency.Builder packageName(java.lang.String packageName)

Sets the package name of the dependency.

Parameters:

packageName - Package name to set.

Returns:

Returns the builder.

version

public SymbolDependency.Builder version(java.lang.String version)

Sets the version string of the dependency.

Parameters:

version - Opaque version string to set.

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.

putProperty

public <K> T 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 T removeProperty(java.lang.String key)

Removes a specific custom property.

Parameters:

key - Key to remove.

Returns:

Returns the builder.

removeProperty

public T removeProperty(Property<?> property)

Removes a specific, typed custom property.

Parameters:

property - Property to remove.

Returns:

Returns the builder.

properties

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

Replaces all the custom properties.

Parameters:

properties - Custom properties to replace with.

Returns:

Returns the builder.

typedProperties

public T typedProperties(java.util.Map<Property<?>,java.lang.Object> properties)

Replaces all the custom typed properties.

Parameters:

properties - Custom typed properties to replace with.

Returns:

Returns the builder.