Top Description Fields Constructors Methods
liquibase.ui

public Class CompositeUIService

extends AbstractExtensibleObject
implements UIService
Class Inheritance
All Implemented Interfaces
liquibase.ui.UIService, liquibase.plugin.Plugin, liquibase.ExtensibleObject, java.lang.Cloneable
Annotations
@Beta
Imports
liquibase.AbstractExtensibleObject, .Beta, java.util.ArrayList, .Collection, .List
Used for handling multiple UI output services.

Field Summary

Modifier and TypeField and Description
public final UIService
inputService

public final List<UIService>
outputServices

Constructor Summary

AccessConstructor and Description
public
CompositeUIService(UIService inputService, Collection<UIService> outputServices)

Method Summary

Modifier and TypeMethod and Description
public boolean
getAllowPrompt()

Implements liquibase.ui.UIService.getAllowPrompt.

Return current setting of allow prompt flag

public List<UIService>
getOutputServices()

public int
getPriority()

Implements liquibase.ui.UIService.getPriority.

public <T> T
prompt(String prompt, T valueIfNoEntry, InputHandler<T> inputHandler, Class<T> type)

Implements liquibase.ui.UIService.prompt.

Prompt the user with the message and wait for a response.

public void
sendErrorMessage(String message)

Implements liquibase.ui.UIService.sendErrorMessage.

Send an "error" message to the user.

public void
sendErrorMessage(String message, Throwable exception)

Implements liquibase.ui.UIService.sendErrorMessage.

Send an "error" message to the user along with a stacktrace.

public void
sendMessage(String message)

Implements liquibase.ui.UIService.sendMessage.

Send a "normal" message to the user.

public void
setAllowPrompt(boolean
New flag value
allowPrompt)

Implements liquibase.ui.UIService.setAllowPrompt.

Method to set flag indicating whether prompting is allowed

Inherited from liquibase.AbstractExtensibleObject:
clonedescribeequalsgetgetgetgetAttributesgetFieldValuegetObjectMetaDatagetValuePathhashashCodesettoString

Field Detail

inputServiceback to summary
public final UIService inputService
outputServicesback to summary
public final List<UIService> outputServices

Constructor Detail

CompositeUIServiceback to summary
public CompositeUIService(UIService inputService, Collection<UIService> outputServices)

Method Detail

getAllowPromptback to summary
public boolean getAllowPrompt()

Implements liquibase.ui.UIService.getAllowPrompt.

Doc from liquibase.ui.UIService.getAllowPrompt.

Return current setting of allow prompt flag

Returns:boolean

boolean

Annotations
@Override
getOutputServicesback to summary
public List<UIService> getOutputServices()
getPriorityback to summary
public int getPriority()

Implements liquibase.ui.UIService.getPriority.

Annotations
@Override
promptback to summary
public <T> T prompt(String prompt, T valueIfNoEntry, InputHandler<T> inputHandler, Class<T> type)

Implements liquibase.ui.UIService.prompt.

Doc from liquibase.ui.UIService.prompt.

Prompt the user with the message and wait for a response.
If this UIService implementation does not support user prompts, return the default value.
If inputHandler is null, DefaultInputHandler will be used.
If inputHandler throws an IllegalArgumentException, the user will be given the chance to re-enter the value.
If the inputHandler returns true for InputHandler#shouldAllowEmptyInput() and the user enters an empty value when prompted, or hits "enter", the valueIfNoEntry will be returned. If the inputHandler returns false for InputHandler#shouldAllowEmptyInput(), the user will be reprompted until they enter a non-empty value, which will then be returned.

Annotations
@Override
sendErrorMessageback to summary
public void sendErrorMessage(String message)

Implements liquibase.ui.UIService.sendErrorMessage.

Doc from liquibase.ui.UIService.sendErrorMessage.

Send an "error" message to the user.

Annotations
@Override
sendErrorMessageback to summary
public void sendErrorMessage(String message, Throwable exception)

Implements liquibase.ui.UIService.sendErrorMessage.

Doc from liquibase.ui.UIService.sendErrorMessage.

Send an "error" message to the user along with a stacktrace.

Annotations
@Override
sendMessageback to summary
public void sendMessage(String message)

Implements liquibase.ui.UIService.sendMessage.

Doc from liquibase.ui.UIService.sendMessage.

Send a "normal" message to the user.

Annotations
@Override
setAllowPromptback to summary
public void setAllowPrompt(boolean allowPrompt) throws IllegalArgumentException

Implements liquibase.ui.UIService.setAllowPrompt.

Doc from liquibase.ui.UIService.setAllowPrompt.

Method to set flag indicating whether prompting is allowed

Parameters
allowPrompt:boolean

New flag value

Annotations
@Override
Exceptions
IllegalArgumentException:
If parameter is not allowed