org.forgerock.openidconnect

Class Claim.ClaimBuilder

java.lang.Object

org.forgerock.openidconnect.Claim.ClaimBuilder

Enclosing class:

Claim

public static class Claim.ClaimBuilder
extends Object

Builder to keep this immutable.

Constructor Summary

Constructors

Constructor and Description
ClaimBuilder()

Method Summary

Modifier and Type	Method and Description
Claim	build() Return the claim this builder was building.
Claim.ClaimBuilder	isEssential() Marks this ClaimBuilder as building an essential claim.
Claim.ClaimBuilder	withLocale(String locale) Sets the locale of the ClaimBuilder.
Claim.ClaimBuilder	withName(String name) Sets the name of the ClaimBuilder.
Claim.ClaimBuilder	withValues(List<String> values) Adds to the set of values for the ClaimBuilder.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClaimBuilder

public ClaimBuilder()

Method Detail

build

public Claim build()

Return the claim this builder was building.

Returns:

A claim with the values set in this Builder.

withName

public Claim.ClaimBuilder withName(String name)

Sets the name of the ClaimBuilder.

Parameters:

name - Claim's name.

Returns:

This builder.

withLocale

public Claim.ClaimBuilder withLocale(String locale)

Sets the locale of the ClaimBuilder.

Parameters:

locale - Claim's locale.

Returns:

This builder.

withValues

public Claim.ClaimBuilder withValues(List<String> values)

Adds to the set of values for the ClaimBuilder.

Parameters:

values - Values to add..

Returns:

This builder.

isEssential

public Claim.ClaimBuilder isEssential()

Marks this ClaimBuilder as building an essential claim.

Returns:

This builder.