Package org.forgerock.openam.authentication.callbacks

Class BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder

java.lang.Object

org.forgerock.openam.authentication.callbacks.BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder

Enclosing class:

BooleanAttributeInputCallback

@Supported
public static class BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder
extends Object

Builder object for a StringAttributeInputCallback.

Method Summary

Modifier and Type	Method	Description
BooleanAttributeInputCallback	build()	Finalize the construction process and return the newly constructed callback.
BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder	withName(String name)	Set the name of the attribute.
BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder	withPolicies(JsonValue policies)	Set the list of policies for this attribute.
BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder	withPrompt(String prompt)	Set the prompt of the attribute.
BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder	withRequired(boolean required)	Set whether the attribute is required.
BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder	withValidateOnly(boolean validateOnly)	Set whether the tree should not advance when validation succeeds.
BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder	withValue(Boolean value)	Set the existing value of the attribute.

Methods inherited from class java.lang.Object

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

Method Details

withName

@Supported
public BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder withName(String name)

Set the name of the attribute.

Parameters:

name - the name of the attribute

Returns:

this builder

withPrompt

@Supported
public BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder withPrompt(String prompt)

Set the prompt of the attribute.

Parameters:

prompt - the prompt of the attribute

Returns:

this builder

withValue

@Supported
public BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder withValue(Boolean value)

Set the existing value of the attribute.

Parameters:

value - the existing value of the attribute

Returns:

this builder

withRequired

@Supported
public BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder withRequired(boolean required)

Set whether the attribute is required.

Parameters:

required - whether the attribute is required

Returns:

this builder

withPolicies

@Supported
public BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder withPolicies(JsonValue policies)

Set the list of policies for this attribute.

Parameters:

policies - the list of policies that apply to this attribute

Returns:

this builder

withValidateOnly

@Supported
public BooleanAttributeInputCallback.BooleanAttributeInputCallbackBuilder withValidateOnly(boolean validateOnly)

Set whether the tree should not advance when validation succeeds.

Parameters:

validateOnly - set to true if and only if successful validation should not result in advancing the tree

Returns:

this builder

build

@Supported
public BooleanAttributeInputCallback build()

Finalize the construction process and return the newly constructed callback.

Returns:

the constructed callback