Package software.amazon.smithy.utils

Class DefaultBuilderRef<T>

java.lang.Object

software.amazon.smithy.utils.DefaultBuilderRef<T>

Type Parameters:

T - The type of value being built, borrowed, and copied.

All Implemented Interfaces:

BuilderRef<T>

public final class DefaultBuilderRef<T>
extends Object
implements BuilderRef<T>

Default implementation of BuilderRef.

This class is not threadsafe; it should only be used to build up other objects using copy().

Constructor Summary

Constructors

Constructor	Description
DefaultBuilderRef(Supplier<T> ctor, Function<T,T> copyCtor, Function<T,T> immutableWrapper, Supplier<T> emptyCtorOptimization)

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes any borrowed or owned values from the reference.
T	copy()	Creates an immutable copy of T.
T	get()
boolean	hasValue()	Checks if the reference currently has a borrowed or owned value.
T	peek()
void	setBorrowed(T value)	Sets a borrowed (immutable) value directly, clearing any owned state.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultBuilderRef

public DefaultBuilderRef(Supplier<T> ctor,
 Function<T,T> copyCtor,
 Function<T,T> immutableWrapper,
 Supplier<T> emptyCtorOptimization)

Method Details

get

public T get()

peek

public T peek()

copy

public T copy()

Description copied from interface: BuilderRef

Creates an immutable copy of T.

Subsequent calls to BuilderRef.hasValue() may or may not return true after this method is called.

Specified by:

copy in interface BuilderRef<T>

Returns:

Returns the copied immutable value.

hasValue

public boolean hasValue()

Description copied from interface: BuilderRef

Checks if the reference currently has a borrowed or owned value.

This method does not check if the contained value is considered empty. This method only returns true if the reference contains any kind of previously built value. This might be useful for builder methods that attempt to remove values from the contained object. If there is no contained object, then there's no need to create one just to remove a value from an empty container.

Specified by:

hasValue in interface BuilderRef<T>

Returns:

Returns true if the reference contains a value of any kind.

clear

public void clear()

Description copied from interface: BuilderRef

Removes any borrowed or owned values from the reference.

Subsequent calls to BuilderRef.hasValue() will return false after this method is called.

Specified by:

clear in interface BuilderRef<T>

setBorrowed

public void setBorrowed(T value)

Description copied from interface: BuilderRef

Sets a borrowed (immutable) value directly, clearing any owned state.

This enables the toBuilder() optimization: when creating a builder from an existing built object, the already-immutable collections can be set directly without copying. A copy will only be made if the builder actually mutates the value via get().

Specified by:

setBorrowed in interface BuilderRef<T>

Parameters:

value - The immutable value to borrow. May be null to clear.