dev.codesoapbox.dummy4j.dummies.identifier.internationalnumber.booknumber

Class IsbnBuilder

java.lang.Object

dev.codesoapbox.dummy4j.dummies.identifier.internationalnumber.booknumber.IsbnBuilder

public class IsbnBuilder
extends Object

Provides methods for generating a random ISBN according to customizable parameters

Since:

0.9.0

Constructor Summary

Constructors

Constructor and Description
IsbnBuilder(Dummy4j dummy4j, IsbnValidator validator, InternationalNumberCheckDigitFormulaProvider checkDigitFormulaProvider)

Method Summary

Modifier and Type	Method and Description
Isbn	build() Generates a random ISBN
String	toString()
IsbnBuilder	withoutSeparator() The generated ISBN will contain only digits and no separator
IsbnBuilder	withPrefix(String prefix) Sets the prefix of the generated ISBN.
IsbnBuilder	withPublication(String publication) Sets the publication of the generated ISBN.
IsbnBuilder	withRandomPrefix() Sets a random prefix for the generated ISBN to one that is randomly chosen from the yml definitions.
IsbnBuilder	withRandomPrefix(String... prefixes) Sets the prefix for the generated ISBN to one that is randomly chosen from provided arguments.
IsbnBuilder	withRandomPublication() Sets a random publication for the generated ISBN.
IsbnBuilder	withRandomPublication(String... publications) Sets the publication for the generated ISBN to one that is randomly chosen from provided arguments.
IsbnBuilder	withRandomRegistrant() Sets a random registrant for the generated ISBN.
IsbnBuilder	withRandomRegistrant(String... registrants) Sets the registrant for the generated ISBN to one that is randomly chosen from provided arguments.
IsbnBuilder	withRandomRegistrationGroup() Sets a random registration group for the generated ISBN.
IsbnBuilder	withRandomRegistrationGroup(String... registrationGroups) Sets the registration group for the generated ISBN to one that is randomly chosen from provided arguments.
IsbnBuilder	withRandomSeparator() Sets a separator for the generated ISBN to one that is randomly chosen from the yml definitions.
IsbnBuilder	withRandomSeparator(String... separators) Sets the separator for the generated ISBN to one that is randomly chosen from provided arguments
IsbnBuilder	withRandomType() Sets a random type for the generated ISBN (10 or 13 character length).
IsbnBuilder	withRandomType(IsbnType... types) Sets the type for the generated ISBN to one that is randomly chosen from provided arguments
IsbnBuilder	withRegistrant(String registrant) Sets the registrant of the generated ISBN.
IsbnBuilder	withRegistrationGroup(String group) Sets the registration group of the generated ISBN.
IsbnBuilder	withSeparator(String separator) Sets the separator used for formatting ISBN
IsbnBuilder	withType(IsbnType type) Sets the type of the generated ISBN

Methods inherited from class java.lang.Object

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

Constructor Detail

IsbnBuilder

public IsbnBuilder(Dummy4j dummy4j,
                   IsbnValidator validator,
                   InternationalNumberCheckDigitFormulaProvider checkDigitFormulaProvider)

Method Detail

withRandomType

public IsbnBuilder withRandomType()

Sets a random type for the generated ISBN (10 or 13 character length).

This is the default behavior for this builder.

See Also:

IsbnType

withRandomType

public IsbnBuilder withRandomType(IsbnType... types)

Sets the type for the generated ISBN to one that is randomly chosen from provided arguments

See Also:

IsbnType

withType

public IsbnBuilder withType(IsbnType type)

Sets the type of the generated ISBN

See Also:

IsbnType

withRandomPrefix

public IsbnBuilder withRandomPrefix()

Sets a random prefix for the generated ISBN to one that is randomly chosen from the yml definitions.

This is the default behavior for this builder.

withRandomPrefix

public IsbnBuilder withRandomPrefix(String... prefixes)

Sets the prefix for the generated ISBN to one that is randomly chosen from provided arguments.

The builder tries to adjust the length of the remaining auto-generated ISBN elements so that the valid ISBN length is preserved.

However, combining custom prefixes, registration groups, registrants or publications can result in invalid ISBN if their combined length would not produce a valid ISBN and the builder would have no auto-generated elements left to trim (or trimming them would still not produce a valid ISBN length.

Therefore, it is advised to make sure that every combination of parameters passed to this builder would produce an ISBN of valid length.

Throws:

InvalidIsbnParameterException - when the provided arguments fail validation

withPrefix

public IsbnBuilder withPrefix(String prefix)

Sets the prefix of the generated ISBN.

The builder tries to adjust the length of the remaining auto-generated ISBN elements so that the valid ISBN length is preserved.

However, combining custom prefixes, registration groups, registrants or publications can result in invalid ISBN if their combined length would not produce a valid ISBN and the builder would have no auto-generated elements left to trim (or trimming them would still not produce a valid ISBN length.

Therefore, it is advised to make sure that every combination of parameters passed to this builder would produce an ISBN of valid length.

Throws:

InvalidIsbnParameterException - when the provided argument fails validation

withRandomRegistrationGroup

public IsbnBuilder withRandomRegistrationGroup()

Sets a random registration group for the generated ISBN.

This is the default behavior for this builder.

withRandomRegistrationGroup

public IsbnBuilder withRandomRegistrationGroup(String... registrationGroups)

Sets the registration group for the generated ISBN to one that is randomly chosen from provided arguments.

The builder tries to adjust the length of the remaining auto-generated ISBN elements so that the valid ISBN length is preserved.

However, combining custom prefixes, registration groups, registrants or publications can result in invalid ISBN if their combined length would not produce a valid ISBN and the builder would have no auto-generated elements left to trim (or trimming them would still not produce a valid ISBN length.

Therefore, it is advised to make sure that every combination of parameters passed to this builder would produce an ISBN of valid length.

Throws:

InvalidIsbnParameterException - when the provided arguments fail validation

withRegistrationGroup

public IsbnBuilder withRegistrationGroup(String group)

Sets the registration group of the generated ISBN.

The builder tries to adjust the length of the remaining auto-generated ISBN elements so that the valid ISBN length is preserved.

However, combining custom prefixes, registration groups, registrants or publications can result in invalid ISBN if their combined length would not produce a valid ISBN and the builder would have no auto-generated elements left to trim (or trimming them would still not produce a valid ISBN length.

Therefore, it is advised to make sure that every combination of parameters passed to this builder would produce an ISBN of valid length.

Throws:

InvalidIsbnParameterException - when the provided argument fails validation

withRandomRegistrant

public IsbnBuilder withRandomRegistrant()

Sets a random registrant for the generated ISBN.

This is the default behavior for this builder.

withRandomRegistrant

public IsbnBuilder withRandomRegistrant(String... registrants)

Sets the registrant for the generated ISBN to one that is randomly chosen from provided arguments.

The builder tries to adjust the length of the remaining auto-generated ISBN elements so that the valid ISBN length is preserved.

However, combining custom prefixes, registration groups, registrants or publications can result in invalid ISBN if their combined length would not produce a valid ISBN and the builder would have no auto-generated elements left to trim (or trimming them would still not produce a valid ISBN length.

Therefore, it is advised to make sure that every combination of parameters passed to this builder would produce an ISBN of valid length.

Throws:

InvalidIsbnParameterException - when the provided arguments fail validation*

withRegistrant

public IsbnBuilder withRegistrant(String registrant)

Sets the registrant of the generated ISBN.

The builder tries to adjust the length of the remaining auto-generated ISBN elements so that the valid ISBN length is preserved.

However, combining custom prefixes, registration groups, registrants or publications can result in invalid ISBN if their combined length would not produce a valid ISBN and the builder would have no auto-generated elements left to trim (or trimming them would still not produce a valid ISBN length.

Therefore, it is advised to make sure that every combination of parameters passed to this builder would produce an ISBN of valid length.

Throws:

InvalidIsbnParameterException - when the provided argument fails validation

withRandomPublication

public IsbnBuilder withRandomPublication()

Sets a random publication for the generated ISBN.

This is the default behavior for this builder.

withRandomPublication

public IsbnBuilder withRandomPublication(String... publications)

Sets the publication for the generated ISBN to one that is randomly chosen from provided arguments.

The builder tries to adjust the length of the remaining auto-generated ISBN elements so that the valid ISBN length is preserved.

However, combining custom prefixes, registration groups, registrants or publications can result in invalid ISBN if their combined length would not produce a valid ISBN and the builder would have no auto-generated elements left to trim (or trimming them would still not produce a valid ISBN length.

Therefore, it is advised to make sure that every combination of parameters passed to this builder would produce an ISBN of valid length.

Throws:

InvalidIsbnParameterException - when the provided arguments fail validation

withPublication

public IsbnBuilder withPublication(String publication)

Sets the publication of the generated ISBN.

The builder tries to adjust the length of the remaining auto-generated ISBN elements so that the valid ISBN length is preserved.

However, combining custom prefixes, registration groups, registrants or publications can result in invalid ISBN if their combined length would not produce a valid ISBN and the builder would have no auto-generated elements left to trim (or trimming them would still not produce a valid ISBN length.

Therefore, it is advised to make sure that every combination of parameters passed to this builder would produce an ISBN of valid length.

Throws:

InvalidIsbnParameterException - when the provided argument fails validation

withRandomSeparator

public IsbnBuilder withRandomSeparator()

Sets a separator for the generated ISBN to one that is randomly chosen from the yml definitions.

This is the default behavior for this builder.

withRandomSeparator

public IsbnBuilder withRandomSeparator(String... separators)

Sets the separator for the generated ISBN to one that is randomly chosen from provided arguments

withSeparator

public IsbnBuilder withSeparator(String separator)

Sets the separator used for formatting ISBN

withoutSeparator

public IsbnBuilder withoutSeparator()

The generated ISBN will contain only digits and no separator

build

public Isbn build()

Generates a random ISBN

toString

public String toString()

Overrides:

toString in class Object