How do I mask password input with Text-IO?

Use the .withInputMasking(true) method on a string input reader, as shown in the README example. This hides characters as typed, similar to password fields in GUIs, ensuring secure data entry without custom code.

Text-IO vs java.util.Scanner for console input?

Text-IO is better for interactive apps with validation and masking, offering a fluent API and built-in constraints. Scanner is simpler for basic parsing but lacks advanced features. Choose Text-IO if you need robust input handling with less boilerplate.

Can I use Text-IO in a web application?

Yes, through its web-based terminal implementation, which allows browser access. However, it's designed for console-like interaction and isn't a full web framework, so it's best for adding terminal interfaces to web apps rather than replacing front-end logic.

How to add custom validation in Text-IO?

Extend input reader classes or use methods like .withValueChecker() in the fluent API. The library supports custom validators, allowing you to define specific rules, such as business logic constraints, beyond the built-in options.

What happens if there's no console available in my environment?

Text-IO automatically falls back to a Swing-based terminal, as mentioned in the README. This ensures compatibility in IDEs or headless setups, but may require Swing dependencies and could affect the user experience.

How to integrate Text-IO with Maven or Gradle?

Add the dependency from Maven Central; for example, in Maven's pom.xml, use the artifact 'org.beryx:text-io'. Check the README for the latest version and setup instructions, as it's widely available in repositories.

Open-Awesome

Text-IO

Apache-2.0Javav3.4.1

A Java library for creating interactive console applications with rich input handling and multiple terminal backends.

Visit Website GitHub

354 stars46 forks0 contributors

What is Text-IO?

Text-IO is a Java library for creating interactive console applications that need to read user input. It provides a fluent API for handling various data types, input masking, and validation, while supporting multiple terminal backends like console, Swing, and web-based interfaces. The library solves the problem of building robust command-line interfaces with minimal boilerplate code.

Target Audience

Java developers building command-line tools, interactive console applications, or educational software that requires user input handling. It's particularly useful for projects needing secure input, validation, or multi-terminal support.

Value Proposition

Developers choose Text-IO for its ease of use, comprehensive input validation features, and flexibility in terminal implementations. Its fluent API and support for constraints and masking make it a powerful alternative to basic Java console input methods.

Overview

A library for creating interactive console applications in Java

Use Cases

Best For

Building interactive command-line tools with user input validation
Creating console applications that require secure password input with masking
Developing educational or training software with menu-driven interfaces
Implementing multi-terminal applications (console, Swing, web-based)
Simplifying input handling in Java CLI projects with type-safe readers
Adding constraint-based input (ranges, patterns) to console apps

Not Ideal For

Applications requiring full graphical user interfaces beyond console interaction, such as those built with JavaFX or Swing for rich UI components.
Server-side batch processing jobs that handle input programmatically without user interaction, like automated data pipelines.
Projects aiming for minimal third-party dependencies and preferring to use only Java SE libraries for input handling.
Real-time systems where low-latency input reading is critical and the abstraction layer might introduce performance overhead.

Pros & Cons

Pros

Fluent Input API

Provides a chainable interface for reading various data types, making code concise and readable, as shown in the example with methods like .withDefaultValue() and .withMinLength().

Built-in Validation

Supports type-safe reading, pattern matching, and range checks, reducing boilerplate code for input constraints, such as with .withMinVal() for integers.

Secure Input Masking

Enables masking of sensitive inputs like passwords using .withInputMasking(true), enhancing security in command-line applications without extra effort.

Multi-Terminal Support

Offers implementations for console, Swing, and web-based terminals, with an SPI for customization, ensuring compatibility in diverse environments like IDEs or browsers.

Cons

Additional Dependencies

Requires importing an external library, which can increase project complexity and dependency management compared to using standard Java classes like Scanner.

Setup Complexity

Configuring non-standard terminals, such as the web-based implementation, may involve additional steps and a learning curve, as noted in the documentation links.

Console-Centric Focus

Primarily designed for console apps, limiting its utility in applications dominated by GUI or web interfaces without console interaction components.

Frequently Asked Questions

Related Projects

Lanterna

Java library for creating text-based GUIs

Stars2,615

Forks276

Last commit2 months ago

Jansi

Jansi is a small java library that allows you to use ANSI escape sequences to format your console output which works even on windows.

Stars1,200

Forks153

Last commit5 months ago

Jexer

Advanced console (and Swing) text user interface (TUI) library, with mouse-draggable windows, built-in terminal window manager, and sixel image support. Looks like Turbo Vision

Stars0

Forks0

Last commit

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub