Module java.money

Package javax.money.convert

Class ProviderContextBuilder

java.lang.Object

javax.money.AbstractContextBuilder<ProviderContextBuilder,ProviderContext>

javax.money.convert.ProviderContextBuilder

public final class ProviderContextBuilder
extends AbstractContextBuilder<ProviderContextBuilder,ProviderContext>

Builder class to of ProviderContext instances. Instances of this class are not thread-safe.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ProviderContextBuilder(java.lang.String provider, java.util.Collection<RateType> rateTypes)	Create a new Builder instance.
private	ProviderContextBuilder(java.lang.String provider, RateType rateType, RateType... rateTypes)	Create a new Builder instance.
private	ProviderContextBuilder(ProviderContext context)	Create a new Builder, hereby using the given ProviderContext 's values as defaults.

Method Summary

Modifier and Type	Method	Description
ProviderContext	build()	Creates a new ProviderContext with the data from this Builder instance.
static ProviderContextBuilder	create(ProviderContext context)	Create a new ProviderContextBuilder, hereby using the given ProviderContext 's values as defaults.
static ProviderContextBuilder	of(java.lang.String provider, java.util.Collection<RateType> rateTypes)	Create a new ProviderContextBuilder instance.
static ProviderContextBuilder	of(java.lang.String provider, RateType rateType, RateType... rateTypes)	Create a new ProviderContextBuilder instance.
ProviderContextBuilder	setRateTypes(java.util.Collection<RateType> rateTypes)	Set the rate types.
ProviderContextBuilder	setRateTypes(RateType... rateTypes)	Set the rate types.

Methods inherited from class javax.money.AbstractContextBuilder

importContext, importContext, removeAttributes, set, set, set, set, set, set, set, set, set, setProviderName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ProviderContextBuilder

private ProviderContextBuilder(java.lang.String provider,
                               RateType rateType,
                               RateType... rateTypes)

Create a new Builder instance.

Parameters:

provider - the provider name, not null.

rateTypes - the rate types, not null and not empty.

ProviderContextBuilder

private ProviderContextBuilder(java.lang.String provider,
                               java.util.Collection<RateType> rateTypes)

Create a new Builder instance.

Parameters:

provider - the provider name, not null.

rateTypes - the rate types, not null and not empty.

ProviderContextBuilder

private ProviderContextBuilder(ProviderContext context)

Create a new Builder, hereby using the given ProviderContext 's values as defaults. This allows changing an existing ProviderContext easily.

Parameters:

context - the context, not null

Method Detail

setRateTypes

public ProviderContextBuilder setRateTypes(RateType... rateTypes)

Set the rate types.

Parameters:

rateTypes - the rate types, not null and not empty.

Returns:

this, for chaining.

Throws:

java.lang.IllegalArgumentException - when not at least one RateType is provided.

setRateTypes

public ProviderContextBuilder setRateTypes(java.util.Collection<RateType> rateTypes)

Set the rate types.

Parameters:

rateTypes - the rate types, not null and not empty.

Returns:

this, for chaining.

Throws:

java.lang.IllegalArgumentException - when not at least one RateType is provided.

build

public ProviderContext build()

Creates a new ProviderContext with the data from this Builder instance.

Specified by:

build in class AbstractContextBuilder<ProviderContextBuilder,ProviderContext>

Returns:

a new ProviderContext. never null.

create

public static ProviderContextBuilder create(ProviderContext context)

Create a new ProviderContextBuilder, hereby using the given ProviderContext 's values as defaults. This allows changing an existing ProviderContext easily.

Parameters:

context - the context, not null

Returns:

a new ProviderContextBuilder instance, never null.

of

public static ProviderContextBuilder of(java.lang.String provider,
                                        RateType rateType,
                                        RateType... rateTypes)

Create a new ProviderContextBuilder instance.

Parameters:

provider - the provider name, not null.

rateType - the required RateType, not null

rateTypes - the rate types, not null and not empty.

Returns:

a new ProviderContextBuilder instance, never null.

of

public static ProviderContextBuilder of(java.lang.String provider,
                                        java.util.Collection<RateType> rateTypes)

Create a new ProviderContextBuilder instance.

Parameters:

provider - the provider name, not null.

rateTypes - the rate types, not null and not empty.

Returns:

a new ProviderContextBuilder instance, never null.