fr.sii.ogham.sms.builder

Class PhoneNumbersBuilder

java.lang.Object

fr.sii.ogham.core.fluent.AbstractParent<SmsBuilder>

fr.sii.ogham.sms.builder.PhoneNumbersBuilder

All Implemented Interfaces:

Builder<PhoneNumberTranslatorPair>, Parent<SmsBuilder>

public class PhoneNumbersBuilder
extends AbstractParent<SmsBuilder>
implements Builder<PhoneNumberTranslatorPair>

Configures the phone number conversions (from a PhoneNumber to an AddressedPhoneNumber). The PhoneNumber is used by the developer to provide a simple phone number without knowing how phone number works (no need to handle formats, addressing, countries...). The AddressedPhoneNumber is used by Ogham implementations to have a phone number that is usable by a technical system.

Author:

Aurélien Baudet

Field Summary

Fields inherited from class fr.sii.ogham.core.fluent.AbstractParent

parent

Constructor Summary

Constructors

Constructor and Description
PhoneNumbersBuilder(SmsBuilder parent, BuildContext buildContext) Initializes the builder with a parent builder.

Method Summary

Modifier and Type	Method and Description
PhoneNumberTranslatorPair	build() Instantiate and configures the instance.
SenderNumberBuilder	from() Configures the sender phone number conversion (from a PhoneNumber to an AddressedPhoneNumber).
RecipientNumberBuilder	to() Configures the recipient phone number conversion (from a PhoneNumber to an AddressedPhoneNumber).

Methods inherited from class fr.sii.ogham.core.fluent.AbstractParent

and

Methods inherited from class java.lang.Object

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

Constructor Detail

PhoneNumbersBuilder

public PhoneNumbersBuilder(SmsBuilder parent,
                           BuildContext buildContext)

Initializes the builder with a parent builder. The parent builder is used when calling AbstractParent.and() method. The EnvironmentBuilder is used to evaluate properties when build() method is called.

Parameters:

parent - the parent builder

buildContext - for registering instances and property evaluation

Method Detail

from

public SenderNumberBuilder from()

Configures the sender phone number conversion (from a PhoneNumber to an AddressedPhoneNumber). The PhoneNumber is used by the developer to provide a simple phone number without knowing how phone number works (no need to handle formats, addressing, countries...). The AddressedPhoneNumber is used by Ogham implementations to have a phone number that is usable by a technical system.

Returns:

the builder to configure the sender phone number

to

public RecipientNumberBuilder to()

Configures the recipient phone number conversion (from a PhoneNumber to an AddressedPhoneNumber). The PhoneNumber is used by the developer to provide a simple phone number without knowing how phone number works (no need to handle formats, addressing, countries...). The AddressedPhoneNumber is used by Ogham implementations to have a phone number that is usable by a technical system.

Returns:

the builder to configure the recipient phone number

build

public PhoneNumberTranslatorPair build()

Description copied from interface: Builder

Instantiate and configures the instance.

Specified by:

build in interface Builder<PhoneNumberTranslatorPair>

Returns:

The built instance