https://github.com/beryx/text-io

A library for creating interactive console applications in Java
https://github.com/beryx/text-io

console text-based

Last synced: 12 days ago
JSON representation

A library for creating interactive console applications in Java

• Host: GitHub
• URL: https://github.com/beryx/text-io
• Owner: beryx
• License: apache-2.0
• Created: 2016-11-09T22:36:25.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-11-02T08:49:43.000Z (about 1 year ago)
• Last Synced: 2024-08-01T18:24:24.651Z (3 months ago)
• Topics: console, text-based
• Language: Java
• Homepage: http://text-io.beryx.org/
• Size: 9.54 MB
• Stars: 337
• Watchers: 14
• Forks: 45
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-java - Text-IO - Aids the creation of full console-based applications. (Projects / CLI)
• awesome-java-zh - Text-IO - 帮助创建完整的基于控制台的应用程序。 (项目 / CLI)
• awesome-java - Text-IO - Aids the creation of full console-based applications. (Projects / CLI)

README

        
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/beryx/text-io/blob/master/LICENSE)

[![Build Status](https://img.shields.io/travis/beryx/text-io/master.svg?label=Build)](https://travis-ci.org/beryx/text-io)

## Text-IO ##

Text-IO is a library for creating Java console applications.

It can be used in applications that need to read interactive input from the user.

**Features**

- supports reading values with various data types.

- allows masking the input when reading sensitive data.

- allows selecting a value from a list.

- allows to specify constraints on the input values (format patterns, value ranges, length constraints etc.).

- provides different terminal implementations and offers a Service Provider Interface (SPI) for configuring additional text terminals.

By default, Text-IO tries to use text terminals backed by [java.io.Console](http://docs.oracle.com/javase/8/docs/api/java/io/Console.html).

If no console device is present (which may happen, for example, when running the application in your IDE),

a Swing-based terminal is used instead.

*Example*

```

TextIO textIO = TextIoFactory.getTextIO();

String user = textIO.newStringInputReader()

        .withDefaultValue("admin")

        .read("Username");

String password = textIO.newStringInputReader()

        .withMinLength(6)

        .withInputMasking(true)

        .read("Password");

int age = textIO.newIntInputReader()

        .withMinVal(13)

        .read("Age");

Month month = textIO.newEnumInputReader(Month.class)

        .read("What month were you born in?");

TextTerminal terminal = textIO.getTextTerminal();

terminal.printf("\nUser %s is %d years old, was born in %s and has the password %s.\n",

        user, age, month, password);

```

Click on the image below to see the output of the above example in a Swing-based terminal.



You can also use a web-based terminal, which allows you to access your application via a browser, as shown in the image below.



**Useful links**

 - [Documentation](http://text-io.beryx.org)

 - [javadoc](http://text-io.beryx.org/releases/latest/javadoc)

 - [Demos, examples and projects using Text-IO](https://github.com/beryx/text-io/wiki/Demos,-Examples-and-Projects-using-Text-IO)

 - [List of all releases](https://github.com/beryx/text-io/blob/gh-pages/releases.md)

Text-IO is available in [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.beryx%22%20AND%20a%3A%22text-io%22) and [JCenter](https://bintray.com/beryx/maven/text-io).