Package org.apache.maven.cli.jline

Class JLineMessageBuilderFactory

java.lang.Object

org.apache.maven.cli.jline.JLineMessageBuilderFactory

All Implemented Interfaces:

Service, MessageBuilderFactory, org.codehaus.plexus.components.interactivity.InputHandler, org.codehaus.plexus.components.interactivity.OutputHandler, org.codehaus.plexus.components.interactivity.Prompter

@Experimental
@Named
@Singleton
@Priority(10)
public class JLineMessageBuilderFactory
extends Object
implements MessageBuilderFactory, org.codehaus.plexus.components.interactivity.Prompter, org.codehaus.plexus.components.interactivity.InputHandler, org.codehaus.plexus.components.interactivity.OutputHandler

Field Summary

Fields inherited from interface org.codehaus.plexus.components.interactivity.InputHandler

ROLE

Fields inherited from interface org.codehaus.plexus.components.interactivity.OutputHandler

ROLE

Fields inherited from interface org.codehaus.plexus.components.interactivity.Prompter

ROLE

Constructor Summary

Constructors

Constructor	Description
JLineMessageBuilderFactory()

Method Summary

Modifier and Type	Method	Description
MessageBuilder	builder()	Creates a new message builder.
MessageBuilder	builder(int size)	Creates a new message builder of the specified size.
int	getTerminalWidth()	Returns the terminal width or -1 if not supported.
boolean	isColorEnabled()	Checks if the underlying output does support styling or not.
String	prompt(String message)
String	prompt(String message, String defaultReply)
String	prompt(String message, List possibleValues)
String	prompt(String message, List possibleValues, String defaultReply)
String	promptForPassword(String message)
String	readLine()
List<String>	readMultipleLines()
String	readPassword()
void	showMessage(String message)
void	write(String line)
void	writeLine(String line)

Methods inherited from class java.lang.Object

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

Constructor Details

JLineMessageBuilderFactory

public JLineMessageBuilderFactory()

Method Details

isColorEnabled

public boolean isColorEnabled()

Description copied from interface: MessageBuilderFactory

Checks if the underlying output does support styling or not.

Specified by:

isColorEnabled in interface MessageBuilderFactory

Returns:

whether color styling is supported or not

getTerminalWidth

public int getTerminalWidth()

Description copied from interface: MessageBuilderFactory

Returns the terminal width or -1 if not supported.

Specified by:

getTerminalWidth in interface MessageBuilderFactory

Returns:

the terminal width

builder

public MessageBuilder builder()

Description copied from interface: MessageBuilderFactory

Creates a new message builder.

Specified by:

builder in interface MessageBuilderFactory

Returns:

a new message builder

builder

public MessageBuilder builder(int size)

Description copied from interface: MessageBuilderFactory

Creates a new message builder of the specified size.

Specified by:

builder in interface MessageBuilderFactory

Parameters:

size - the initial size of the message builder buffer

Returns:

a new message builder

readLine

public String readLine()
                throws IOException

Specified by:

readLine in interface org.codehaus.plexus.components.interactivity.InputHandler

Throws:

IOException

readPassword

public String readPassword()
                    throws IOException

Specified by:

readPassword in interface org.codehaus.plexus.components.interactivity.InputHandler

Throws:

IOException

readMultipleLines

public List<String> readMultipleLines()
                               throws IOException

Specified by:

readMultipleLines in interface org.codehaus.plexus.components.interactivity.InputHandler

Throws:

IOException

write

public void write(String line)
           throws IOException

Specified by:

write in interface org.codehaus.plexus.components.interactivity.OutputHandler

Throws:

IOException

writeLine

public void writeLine(String line)
               throws IOException

Specified by:

writeLine in interface org.codehaus.plexus.components.interactivity.OutputHandler

Throws:

IOException

prompt

public String prompt(String message)
              throws org.codehaus.plexus.components.interactivity.PrompterException

Specified by:

prompt in interface org.codehaus.plexus.components.interactivity.Prompter

Throws:

org.codehaus.plexus.components.interactivity.PrompterException

prompt

public String prompt(String message,
 String defaultReply)
              throws org.codehaus.plexus.components.interactivity.PrompterException

Specified by:

prompt in interface org.codehaus.plexus.components.interactivity.Prompter

Throws:

org.codehaus.plexus.components.interactivity.PrompterException

prompt

public String prompt(String message,
 List possibleValues)
              throws org.codehaus.plexus.components.interactivity.PrompterException

Specified by:

prompt in interface org.codehaus.plexus.components.interactivity.Prompter

Throws:

org.codehaus.plexus.components.interactivity.PrompterException

prompt

public String prompt(String message,
 List possibleValues,
 String defaultReply)
              throws org.codehaus.plexus.components.interactivity.PrompterException

Specified by:

prompt in interface org.codehaus.plexus.components.interactivity.Prompter

Throws:

org.codehaus.plexus.components.interactivity.PrompterException

promptForPassword

public String promptForPassword(String message)
                         throws org.codehaus.plexus.components.interactivity.PrompterException

Specified by:

promptForPassword in interface org.codehaus.plexus.components.interactivity.Prompter

Throws:

org.codehaus.plexus.components.interactivity.PrompterException

showMessage

public void showMessage(String message)
                 throws org.codehaus.plexus.components.interactivity.PrompterException

Specified by:

showMessage in interface org.codehaus.plexus.components.interactivity.Prompter

Throws:

org.codehaus.plexus.components.interactivity.PrompterException