Module org.jline.terminal

Package org.jline.terminal

Enum Class Attributes.InputFlag

java.lang.Object

java.lang.Enum<Attributes.InputFlag>

org.jline.terminal.Attributes.InputFlag

All Implemented Interfaces:

Serializable, Comparable<Attributes.InputFlag>, Constable

Enclosing class:

Attributes

public static enum Attributes.InputFlag
extends Enum<Attributes.InputFlag>

Input flags that control how terminal input is processed.

Input flags determine how the terminal processes input characters before they are made available to the application. These flags control aspects such as character mapping, parity checking, and flow control for input.

Common input flags include:

• ICRNL - Map CR to NL on input (convert carriage returns to newlines)
• INLCR - Map NL to CR on input (convert newlines to carriage returns)
• IGNCR - Ignore carriage returns on input
• IXON - Enable XON/XOFF flow control on output
• IXOFF - Enable XON/XOFF flow control on input

Input flags can be accessed and modified using methods like Attributes.getInputFlag(InputFlag), Attributes.setInputFlag(InputFlag, boolean), and Attributes.setInputFlags(EnumSet).

See Also:

• Attributes.getInputFlag(InputFlag)
• Attributes.setInputFlag(InputFlag, boolean)
• Attributes.getInputFlags()
• Attributes.setInputFlags(EnumSet)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BRKINT	Map BREAK to SIGINTR
ICRNL	Map CR to NL
IGNBRK	Ignore BREAK condition
IGNCR	Ignore CR
IGNPAR	Ignore (discard) parity errors
IMAXBEL	Ring bell on input queue full
INLCR	Map NL into CR
INORMEOL	Normalize end-of-line
INPCK	Enable checking of parity errors
ISTRIP	Strip 8th bit off chars
IUCLC	Map upper case to lower case on input (Linux/Solaris)
IUTF8	Maintain state for UTF-8 VERASE
IXANY	Any char will restart after stop
IXOFF	Enable input flow control
IXON	Enable output flow control
PARMRK	Mark parity and framing errors

Method Summary

Modifier and Type	Method	Description
static Attributes.InputFlag	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Attributes.InputFlag[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IGNBRK

public static final Attributes.InputFlag IGNBRK

Ignore BREAK condition

BRKINT

public static final Attributes.InputFlag BRKINT

Map BREAK to SIGINTR

IGNPAR

public static final Attributes.InputFlag IGNPAR

Ignore (discard) parity errors

PARMRK

public static final Attributes.InputFlag PARMRK

Mark parity and framing errors

INPCK

public static final Attributes.InputFlag INPCK

Enable checking of parity errors

ISTRIP

public static final Attributes.InputFlag ISTRIP

Strip 8th bit off chars

INLCR

public static final Attributes.InputFlag INLCR

Map NL into CR

IGNCR

public static final Attributes.InputFlag IGNCR

Ignore CR

ICRNL

public static final Attributes.InputFlag ICRNL

Map CR to NL

IXON

public static final Attributes.InputFlag IXON

Enable output flow control

IXOFF

public static final Attributes.InputFlag IXOFF

Enable input flow control

IXANY

public static final Attributes.InputFlag IXANY

Any char will restart after stop

IMAXBEL

public static final Attributes.InputFlag IMAXBEL

Ring bell on input queue full

IUTF8

public static final Attributes.InputFlag IUTF8

Maintain state for UTF-8 VERASE

IUCLC

public static final Attributes.InputFlag IUCLC

Map upper case to lower case on input (Linux/Solaris)

INORMEOL

public static final Attributes.InputFlag INORMEOL

Normalize end-of-line

Method Details

values

public static Attributes.InputFlag[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Attributes.InputFlag valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null