Class TypeUsage_Builder

java.lang.Object

org.inferred.freebuilder.processor.source.TypeUsage_Builder

Direct Known Subclasses:

TypeUsage.Builder

@Generated("org.inferred.freebuilder.processor.Processor")
abstract class TypeUsage_Builder
extends Object

Auto-generated superclass of TypeUsage.Builder, derived from the API of TypeUsage.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	TypeUsage_Builder.Partial
private static enum	TypeUsage_Builder.Property
private static class	TypeUsage_Builder.Rebuildable
private static final class	TypeUsage_Builder.Value

Field Summary

Fields

Modifier and Type	Field	Description
private final EnumSet<TypeUsage_Builder.Property>	_unsetProperties
private int	end
private QualifiedName	scope
private int	start
private QualifiedName	type

Constructor Summary

Constructors

Constructor	Description
TypeUsage_Builder()

Method Summary

Modifier and Type	Method	Description
TypeUsage	build()	Returns a newly-created TypeUsage based on the contents of this Builder.
TypeUsage	buildPartial()	Returns a newly-created partial TypeUsage for use in unit tests.
TypeUsage.Builder	clear()	Resets the state of this builder.
TypeUsage.Builder	clearScope()	Sets the value to be returned by TypeUsage.scope() to Optional.empty().
int	end()	Returns the value that will be returned by TypeUsage.end().
TypeUsage.Builder	end(int end)	Sets the value to be returned by TypeUsage.end().
static TypeUsage.Builder	from(TypeUsage value)	Creates a new builder using value as a template.
TypeUsage.Builder	mapEnd(IntUnaryOperator mapper)	Replaces the value to be returned by TypeUsage.end() by applying mapper to it and using the result.
TypeUsage.Builder	mapScope(UnaryOperator<QualifiedName> mapper)	If the value to be returned by TypeUsage.scope() is present, replaces it by applying mapper to it and using the result.
TypeUsage.Builder	mapStart(IntUnaryOperator mapper)	Replaces the value to be returned by TypeUsage.start() by applying mapper to it and using the result.
TypeUsage.Builder	mapType(UnaryOperator<QualifiedName> mapper)	Replaces the value to be returned by TypeUsage.type() by applying mapper to it and using the result.
TypeUsage.Builder	mergeFrom(TypeUsage value)	Copies values from value, skipping empty optionals.
TypeUsage.Builder	mergeFrom(TypeUsage.Builder template)	Copies values from template, skipping empty optionals and unset properties.
TypeUsage.Builder	nullableScope(QualifiedName scope)	Sets the value to be returned by TypeUsage.scope().
Optional<QualifiedName>	scope()	Returns the value that will be returned by TypeUsage.scope().
TypeUsage.Builder	scope(Optional<? extends QualifiedName> scope)	Sets the value to be returned by TypeUsage.scope().
TypeUsage.Builder	scope(QualifiedName scope)	Sets the value to be returned by TypeUsage.scope().
int	start()	Returns the value that will be returned by TypeUsage.start().
TypeUsage.Builder	start(int start)	Sets the value to be returned by TypeUsage.start().
QualifiedName	type()	Returns the value that will be returned by TypeUsage.type().
TypeUsage.Builder	type(QualifiedName type)	Sets the value to be returned by TypeUsage.type().

Methods inherited from class Object

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

Field Details

start

private int start

end

private int end

type

private QualifiedName type

scope

private QualifiedName scope

_unsetProperties

private final EnumSet<TypeUsage_Builder.Property> _unsetProperties

Constructor Details

TypeUsage_Builder

TypeUsage_Builder()

Method Details

from

public static TypeUsage.Builder from(TypeUsage value)

Creates a new builder using value as a template.

If value is a partial, the builder will return more partials.

start

public TypeUsage.Builder start(int start)

Sets the value to be returned by TypeUsage.start().

Returns:

this Builder object

mapStart

public TypeUsage.Builder mapStart(IntUnaryOperator mapper)

Replaces the value to be returned by TypeUsage.start() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

NullPointerException - if mapper is null

IllegalStateException - if the field has not been set

start

public int start()

Returns the value that will be returned by TypeUsage.start().

Throws:

IllegalStateException - if the field has not been set

end

public TypeUsage.Builder end(int end)

Sets the value to be returned by TypeUsage.end().

Returns:

this Builder object

mapEnd

public TypeUsage.Builder mapEnd(IntUnaryOperator mapper)

Replaces the value to be returned by TypeUsage.end() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

NullPointerException - if mapper is null

IllegalStateException - if the field has not been set

end

public int end()

Returns the value that will be returned by TypeUsage.end().

Throws:

IllegalStateException - if the field has not been set

type

public TypeUsage.Builder type(QualifiedName type)

Sets the value to be returned by TypeUsage.type().

Returns:

this Builder object

Throws:

NullPointerException - if type is null

mapType

public TypeUsage.Builder mapType(UnaryOperator<QualifiedName> mapper)

Replaces the value to be returned by TypeUsage.type() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

NullPointerException - if mapper is null or returns null

IllegalStateException - if the field has not been set

type

public QualifiedName type()

Returns the value that will be returned by TypeUsage.type().

Throws:

IllegalStateException - if the field has not been set

scope

public TypeUsage.Builder scope(QualifiedName scope)

Sets the value to be returned by TypeUsage.scope().

Returns:

this Builder object

Throws:

NullPointerException - if scope is null

scope

public TypeUsage.Builder scope(Optional<? extends QualifiedName> scope)

Sets the value to be returned by TypeUsage.scope().

Returns:

this Builder object

nullableScope

public TypeUsage.Builder nullableScope(QualifiedName scope)

Sets the value to be returned by TypeUsage.scope().

Returns:

this Builder object

mapScope

public TypeUsage.Builder mapScope(UnaryOperator<QualifiedName> mapper)

If the value to be returned by TypeUsage.scope() is present, replaces it by applying mapper to it and using the result.

If the result is null, clears the value.

Returns:

this Builder object

Throws:

NullPointerException - if mapper is null

clearScope

public TypeUsage.Builder clearScope()

Sets the value to be returned by TypeUsage.scope() to Optional.empty().

Returns:

this Builder object

scope

public Optional<QualifiedName> scope()

Returns the value that will be returned by TypeUsage.scope().

mergeFrom

public TypeUsage.Builder mergeFrom(TypeUsage value)

Copies values from value, skipping empty optionals.

Returns:

this Builder object

mergeFrom

public TypeUsage.Builder mergeFrom(TypeUsage.Builder template)

Copies values from template, skipping empty optionals and unset properties.

Returns:

this Builder object

clear

public TypeUsage.Builder clear()

Resets the state of this builder.

Returns:

this Builder object

build

public TypeUsage build()

Returns a newly-created TypeUsage based on the contents of this Builder.

Throws:

IllegalStateException - if any field has not been set

buildPartial

public TypeUsage buildPartial()

Returns a newly-created partial TypeUsage for use in unit tests. State checking will not be performed. Unset properties will throw an UnsupportedOperationException when accessed via the partial object.

The builder returned by from(TypeUsage) will propagate the partial status of its input, overriding build() to return another partial. This allows for robust tests of modify-rebuild code.

Partials should only ever be used in tests. They permit writing robust test cases that won't fail if this type gains more application-level constraints (e.g. new required fields) in future. If you require partially complete values in production code, consider using a Builder.