io.github.dsibilio.badgemaker.core

Class BadgeFormatBuilder

java.lang.Object

io.github.dsibilio.badgemaker.core.BadgeFormatBuilder

public class BadgeFormatBuilder
extends Object

A builder for BadgeFormat instances

Author:

Domenico Sibilio

Constructor Summary

Constructors

Constructor and Description
BadgeFormatBuilder(String message) It is recommended to use this builder to create BadgeFormat instances.

Method Summary

Modifier and Type	Method and Description
BadgeFormat	build()
BadgeFormatBuilder	withLabel(String label)
BadgeFormatBuilder	withLabelColor(HexColor labelColor)
BadgeFormatBuilder	withLogo(String logo) The logo, must be SVG converted with Base64 encoding. E.g.: data:image/svg+xml;base64,PHN2b...
BadgeFormatBuilder	withMessageColor(HexColor messageColor)
BadgeFormatBuilder	withScaleMultiplier(int scaleMultiplier)

Methods inherited from class java.lang.Object

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

Constructor Detail

BadgeFormatBuilder

public BadgeFormatBuilder(String message)

It is recommended to use this builder to create BadgeFormat instances.

Parameters:

message - the badge message

Method Detail

withLabel

public BadgeFormatBuilder withLabel(String label)

Parameters:

label - the badge label

Returns:

the builder

withLabelColor

public BadgeFormatBuilder withLabelColor(HexColor labelColor)

Parameters:

labelColor - the badge label's color

Returns:

the builder

withMessageColor

public BadgeFormatBuilder withMessageColor(HexColor messageColor)

Parameters:

messageColor - the badge message color

Returns:

the builder

withLogo

public BadgeFormatBuilder withLogo(String logo)

The logo, must be SVG converted with Base64 encoding.
E.g.: data:image/svg+xml;base64,PHN2b...

Parameters:

logo - the badge logo

Returns:

the builder

withScaleMultiplier

public BadgeFormatBuilder withScaleMultiplier(int scaleMultiplier)

Parameters:

scaleMultiplier - the scale multiplier to be applied to the badge, eg. 2 = 2x the original size. It must be within BadgeFormat.SCALE_MULTI_LOWER_BOUND and BadgeFormat.SCALE_MULTI_UPPER_BOUND.

Returns:

the builder

build

public BadgeFormat build()

Returns:

the build BadgeFormat