- java.lang.Object
-
- java.lang.Enum<Attributes.LocalFlag>
-
- org.jline.terminal.Attributes.LocalFlag
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable<Attributes.LocalFlag>
- Enclosing class:
- Attributes
public static enum Attributes.LocalFlag extends java.lang.Enum<Attributes.LocalFlag>
Local flags that control various terminal behaviors.Local flags control a variety of terminal behaviors that don't fit into the other flag categories. These include echo control, canonical mode, signal generation, and special character processing.
Common local flags include:
ECHO- Echo input charactersICANON- Enable canonical mode (line-by-line input)ISIG- Enable signal generation (INTR, QUIT, SUSP)IEXTEN- Enable extended input processingECHOCTL- Echo control characters as ^X
Note: Some flags in this category begin with the letter "I" and might appear to belong in the input flags category, but they are historically part of the local flags.
Local flags can be accessed and modified using methods like
Attributes.getLocalFlag(LocalFlag),Attributes.setLocalFlag(LocalFlag, boolean), andAttributes.setLocalFlags(EnumSet).
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ALTWERASEUse alternate WERASE algorithmECHOEnable echoingECHOCTLEcho control chars as ^(Char)ECHOEVisually erase charsECHOKEcho NL after line killECHOKEVisual erase for line killECHONLEcho NL even if ECHO is offECHOPRTVisual erase mode for hardcopyEXTPROCExternal processingFLUSHOOutput being flushed (state)ICANONCanonicalize input linesIEXTENEnable DISCARD and LNEXTISIGEnable signals INTR, QUIT, [D]SUSPNOFLSHDon't flush after interruptNOKERNINFONo kernel output from VSTATUSPENDINRetype pending input (state)TOSTOPStop background jobs from outputXCASECanonical upper/lower presentation (Linux/Solaris)
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Attributes.LocalFlagvalueOf(java.lang.String name)Returns the enum constant of this type with the specified name.static Attributes.LocalFlag[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ECHOKE
public static final Attributes.LocalFlag ECHOKE
Visual erase for line kill
-
ECHOE
public static final Attributes.LocalFlag ECHOE
Visually erase chars
-
ECHOK
public static final Attributes.LocalFlag ECHOK
Echo NL after line kill
-
ECHO
public static final Attributes.LocalFlag ECHO
Enable echoing
-
ECHONL
public static final Attributes.LocalFlag ECHONL
Echo NL even if ECHO is off
-
ECHOPRT
public static final Attributes.LocalFlag ECHOPRT
Visual erase mode for hardcopy
-
ECHOCTL
public static final Attributes.LocalFlag ECHOCTL
Echo control chars as ^(Char)
-
ISIG
public static final Attributes.LocalFlag ISIG
Enable signals INTR, QUIT, [D]SUSP
-
ICANON
public static final Attributes.LocalFlag ICANON
Canonicalize input lines
-
XCASE
public static final Attributes.LocalFlag XCASE
Canonical upper/lower presentation (Linux/Solaris)
-
ALTWERASE
public static final Attributes.LocalFlag ALTWERASE
Use alternate WERASE algorithm
-
IEXTEN
public static final Attributes.LocalFlag IEXTEN
Enable DISCARD and LNEXT
-
EXTPROC
public static final Attributes.LocalFlag EXTPROC
External processing
-
TOSTOP
public static final Attributes.LocalFlag TOSTOP
Stop background jobs from output
-
FLUSHO
public static final Attributes.LocalFlag FLUSHO
Output being flushed (state)
-
NOKERNINFO
public static final Attributes.LocalFlag NOKERNINFO
No kernel output from VSTATUS
-
PENDIN
public static final Attributes.LocalFlag PENDIN
Retype pending input (state)
-
NOFLSH
public static final Attributes.LocalFlag NOFLSH
Don't flush after interrupt
-
-
Method Detail
-
values
public static Attributes.LocalFlag[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (Attributes.LocalFlag c : Attributes.LocalFlag.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Attributes.LocalFlag valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
java.lang.IllegalArgumentException- if this enum type has no constant with the specified namejava.lang.NullPointerException- if the argument is null
-
-