org.cloudfoundry.uaa.identityzones

Class Branding.Builder

java.lang.Object

org.cloudfoundry.uaa.identityzones.Branding.Builder

Enclosing class:

Branding

public static final class Branding.Builder
extends Object

Builds instances of type Branding. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
Branding	build() Builds a new Branding.
Branding.Builder	companyName(String companyName) Initializes the value for the companyName attribute.
Branding.Builder	footerLegalText(String footerLegalText) Initializes the value for the footerLegalText attribute.
Branding.Builder	footerLink(Map.Entry<String,? extends String> entry) Put one entry to the footerLinks map.
Branding.Builder	footerLink(String key, String value) Put one entry to the footerLinks map.
Branding.Builder	footerLinks(Map<String,? extends String> footerLinks) Sets or replaces all mappings from the specified map as entries for the footerLinks map.
Branding.Builder	from(Branding instance) Fill a builder with attribute values from the provided Branding instance.
Branding.Builder	productLogo(String productLogo) Initializes the value for the productLogo attribute.
Branding.Builder	putAllFooterLinks(Map<String,? extends String> footerLinks) Put all mappings from the specified map as entries to footerLinks map.
Branding.Builder	squareLogo(String squareLogo) Initializes the value for the squareLogo attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final Branding.Builder from(Branding instance)

Fill a builder with attribute values from the provided Branding instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

companyName

public final Branding.Builder companyName(String companyName)

Initializes the value for the companyName attribute.

Parameters:

companyName - The value for companyName (can be null)

Returns:

this builder for use in a chained invocation

footerLegalText

public final Branding.Builder footerLegalText(String footerLegalText)

Initializes the value for the footerLegalText attribute.

Parameters:

footerLegalText - The value for footerLegalText (can be null)

Returns:

this builder for use in a chained invocation

footerLink

public final Branding.Builder footerLink(String key,
                                         String value)

Put one entry to the footerLinks map.

Parameters:

key - The key in the footerLinks map

value - The associated value in the footerLinks map

Returns:

this builder for use in a chained invocation

footerLink

public final Branding.Builder footerLink(Map.Entry<String,? extends String> entry)

Put one entry to the footerLinks map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

footerLinks

public final Branding.Builder footerLinks(Map<String,? extends String> footerLinks)

Sets or replaces all mappings from the specified map as entries for the footerLinks map. Nulls are not permitted as keys or values, but parameter itself can be null

Parameters:

footerLinks - The entries that will be added to the footerLinks map

Returns:

this builder for use in a chained invocation

putAllFooterLinks

public final Branding.Builder putAllFooterLinks(Map<String,? extends String> footerLinks)

Put all mappings from the specified map as entries to footerLinks map. Nulls are not permitted

Parameters:

footerLinks - The entries that will be added to the footerLinks map

Returns:

this builder for use in a chained invocation

productLogo

public final Branding.Builder productLogo(String productLogo)

Initializes the value for the productLogo attribute.

Parameters:

productLogo - The value for productLogo (can be null)

Returns:

this builder for use in a chained invocation

squareLogo

public final Branding.Builder squareLogo(String squareLogo)

Initializes the value for the squareLogo attribute.

Parameters:

squareLogo - The value for squareLogo (can be null)

Returns:

this builder for use in a chained invocation

build

public Branding build()

Builds a new Branding.

Returns:

An immutable instance of Branding

Throws:

IllegalStateException - if any required attributes are missing