Apache Mina SSHD 2.15.0 · org.apache.sshd.common.channel.PtyMode

Field Summary

Modifier and Type	Field and Description
public static final Comparator<PtyMode>	BY_OPCODE A `null`-safe `Comparator` of `PtyMode` values according to their `PtyMode#toInt()` value
public static final NavigableMap<Integer, PtyMode>	COMMANDS
public static final PtyMode	CS7 7 bit mode.
public static final PtyMode	CS8 8 bit mode.
public static final PtyMode	ECHO Enable echoing.
public static final PtyMode	ECHOCTL Echo control characters as ^(Char).
public static final PtyMode	ECHOE Visually erase chars.
public static final PtyMode	ECHOK Kill character discards current line.
public static final PtyMode	ECHOKE Visual erase for line kill.
public static final PtyMode	ECHONL Echo NL even if ECHO is off.
public static final Integer	FALSE_SETTING
public static final PtyMode	ICANON Canonicalize input lines.
public static final PtyMode	ICRNL Map CR to NL on input.
public static final PtyMode	IEXTEN Enable extensions.
public static final PtyMode	IGNCR Ignore CR on input.
public static final PtyMode	IGNPAR The ignore parity flag.
public static final PtyMode	IMAXBEL Ring bell on input queue full.
public static final PtyMode	INLCR Map NL into CR on input.
public static final PtyMode	INPCK Enable checking of parity errors.
public static final PtyMode	ISIG Enable signals INTR, QUIT, [D]SUSP.
public static final PtyMode	ISTRIP Strip 8th bit off characters.
public static final PtyMode	IUCLC Translate uppercase characters to lowercase.
public static final PtyMode	IUTF8
public static final PtyMode	IXANY Any char will restart after stop.
public static final PtyMode	IXOFF Enable input flow control.
public static final PtyMode	IXON Enable output flow control.
public static final Set<PtyMode>	MODES An un-modifiable `Set` of all defined `PtyMode`s
public static final PtyMode	NOFLSH Don't flush after interrupt.
public static final PtyMode	OCRNL Translate carriage return to newline (output).
public static final PtyMode	OLCUC Convert lowercase to uppercase.
public static final PtyMode	ONLCR Map NL to CR-NL.
public static final PtyMode	ONLRET Newline performs a carriage return (output).
public static final PtyMode	ONOCR Translate newline to carriage return-newline (output).
public static final ToIntFunction<PtyMode>	OPCODE_EXTRACTOR A `null`-safe `ToIntFunction` that returns the `PtyMode#toInt()` value and (-1) for `null`
public static final PtyMode	OPOST Enable output processing.
public static final PtyMode	PARENB Parity enable.
public static final PtyMode	PARMRK Mark parity and framing errors.
public static final PtyMode	PARODD Odd parity, else even.
public static final PtyMode	PENDIN Retype pending input.
public static final PtyMode	TOSTOP Stop background jobs from output.
public static final Integer	TRUE_SETTING
public static final byte	TTY_OP_END
public static final PtyMode	TTY_OP_ISPEED Specifies the input baud rate in bits per second.
public static final PtyMode	TTY_OP_OSPEED Specifies the output baud rate in bits per second.
private final int	v
public static final PtyMode	VDISCARD Toggles the flushing of terminal output.
public static final PtyMode	VDSUSP Another suspend character.
public static final PtyMode	VEOF End-of-file character (sends EOF from the terminal).
public static final PtyMode	VEOL End-of-line character in addition to carriage return and/or line-feed.
public static final PtyMode	VEOL2 Additional end-of-line character.
public static final PtyMode	VERASE Erase the character to left of the cursor.
public static final PtyMode	VFLUSH Character to flush output.
public static final PtyMode	VINTR Interrupt character; 255 if none.
public static final PtyMode	VKILL Kill the current input line.
public static final PtyMode	VLNEXT Enter the next character typed literally, even if it is a special character
public static final PtyMode	VQUIT The quit character (sends SIGQUIT signal on POSIX systems).
public static final PtyMode	VREPRINT Reprints the current input line.
public static final PtyMode	VSTART Continues paused output (normally control-Q).
public static final PtyMode	VSTATUS Prints system status line (load, command, pid, etc).
public static final PtyMode	VSTOP Pauses output (normally control-S).
public static final PtyMode	VSUSP Suspends the current program.
public static final PtyMode	VSWTCH Switch to a different shell layer.
public static final PtyMode	VWERASE Erases a word left of cursor.
public static final PtyMode	XCASE Enable input and output of uppercase characters by preceding their lowercase equivalents with "\".

Constructor Summary

Access	Constructor and Description
private	PtyMode(int v)

Method Summary

Modifier and Type	Method and Description
public static Map<PtyMode, Integer>	Returns: A `Map` where all the specified `PtyMode`s have `TRUE_SETTING` createEnabledOptions(PtyMode... The options to enable - ignored if `null`/empty options)
public static Map<PtyMode, Integer>	Returns: A `Map` where all the specified `PtyMode`s have `TRUE_SETTING` createEnabledOptions(Collection<PtyMode> The options to enable - ignored if `null`/empty options)
public static PtyMode	Returns: The matching `PtyMode` or `null` if no match found fromInt(int The numeric value of the option b)
public static PtyMode	fromName(String name)
public static boolean	Returns: `true` if all of these conditions hold: Modes map is not `null`/empty Required mode setting is not `null` The setting has a mapped value The mapped value is a `Number` The `Number#intValue()` is non-zero getBooleanSettingValue(Map<PtyMode, ?> The current modes `Map`-ing modes, PtyMode The required `PtyMode` m)
public static boolean	Returns: `true` if the CR mode is enabled: If`modes` or `enablers` are `null`/empty then `defaultValue` is used If any of the `enablers` modes are enabled then the CR mode is enabled. If none of the `enablers` modes were specified then use `defaultValue` Otherwise (i.e., at least one or more of the `enablers` modes were specified, but all of them said `no`) then `false`. getBooleanSettingValue(Map<PtyMode, ?> The `Map` of `PtyMode`s resolved by the "pty-req" message. modes, Collection<PtyMode> A `Collection` of enabler settings to be consulted enablers, boolean The default value to be used if no definite setting could be deduced defaultValue)
public static boolean	Returns: `true` if all of these conditions hold: The mapped value is a `Number` The `Number#intValue()` is non-zero getBooleanSettingValue(Object The value to be tested v)
public static boolean	Returns: `true` if value is non-zero getBooleanSettingValue(int The setting value v)
public static boolean	Returns: `true` if not `null` and one of the settings that refers to a character value - name usually starts with `Vxxx` isCharSetting(PtyMode The `PtyMode` m)
public static Set<PtyMode>	resolveEnabledOptions(Map<PtyMode, ?> modes, PtyMode... options)
public static Set<PtyMode>	Returns: A `Set` of all the `PtyMode`s that appeared in the settings and were enabled resolveEnabledOptions(Map<PtyMode, ?> The PTY settings - ignored if `null`/empty modes, Collection<PtyMode> The options that should be enabled options)
public int	toInt()
public static PtyMode	valueOf(String name)
public static PtyMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BY_OPCODE back to summary

BY_OPCODE	back to summary
public static final Comparator<PtyMode> BY_OPCODE A `null`-safe `Comparator` of `PtyMode` values according to their `PtyMode#toInt()` value See Also `OPCODE_EXTRACTOR`

public static final Comparator<PtyMode> BY_OPCODE

A null-safe Comparator of PtyMode values according to their PtyMode#toInt() value

See Also: OPCODE_EXTRACTOR

COMMANDS	back to summary
public static final NavigableMap<Integer, PtyMode> COMMANDS

CS7	back to summary
public static final PtyMode CS7 7 bit mode.

CS8	back to summary
public static final PtyMode CS8 8 bit mode.

ECHO	back to summary
public static final PtyMode ECHO Enable echoing.

ECHOCTL	back to summary
public static final PtyMode ECHOCTL Echo control characters as ^(Char).

ECHOE	back to summary
public static final PtyMode ECHOE Visually erase chars.

ECHOK	back to summary
public static final PtyMode ECHOK Kill character discards current line.

ECHOKE	back to summary
public static final PtyMode ECHOKE Visual erase for line kill.

ECHONL	back to summary
public static final PtyMode ECHONL Echo NL even if ECHO is off.

FALSE_SETTING	back to summary
public static final Integer FALSE_SETTING

ICANON	back to summary
public static final PtyMode ICANON Canonicalize input lines.

ICRNL	back to summary
public static final PtyMode ICRNL Map CR to NL on input.

IEXTEN	back to summary
public static final PtyMode IEXTEN Enable extensions.

IGNCR	back to summary
public static final PtyMode IGNCR Ignore CR on input.

IGNPAR	back to summary
public static final PtyMode IGNPAR The ignore parity flag. The parameter SHOULD be 0 if this flag is FALSE, and 1 if it is TRUE.

IMAXBEL	back to summary
public static final PtyMode IMAXBEL Ring bell on input queue full.

INLCR	back to summary
public static final PtyMode INLCR Map NL into CR on input.

INPCK	back to summary
public static final PtyMode INPCK Enable checking of parity errors.

ISIG	back to summary
public static final PtyMode ISIG Enable signals INTR, QUIT, [D]SUSP.

ISTRIP	back to summary
public static final PtyMode ISTRIP Strip 8th bit off characters.

IUCLC	back to summary
public static final PtyMode IUCLC Translate uppercase characters to lowercase.

IUTF8	back to summary
public static final PtyMode IUTF8 See Also IUTF8 Terminal Mode in Secure Shell

IXANY	back to summary
public static final PtyMode IXANY Any char will restart after stop.

IXOFF	back to summary
public static final PtyMode IXOFF Enable input flow control.

IXON	back to summary
public static final PtyMode IXON Enable output flow control.

MODES	back to summary
public static final Set<PtyMode> MODES An un-modifiable `Set` of all defined `PtyMode`s

NOFLSH	back to summary
public static final PtyMode NOFLSH Don't flush after interrupt.

OCRNL	back to summary
public static final PtyMode OCRNL Translate carriage return to newline (output).

OLCUC	back to summary
public static final PtyMode OLCUC Convert lowercase to uppercase.

ONLCR	back to summary
public static final PtyMode ONLCR Map NL to CR-NL.

ONLRET	back to summary
public static final PtyMode ONLRET Newline performs a carriage return (output).

ONOCR	back to summary
public static final PtyMode ONOCR Translate newline to carriage return-newline (output).

OPCODE_EXTRACTOR	back to summary
public static final ToIntFunction<PtyMode> OPCODE_EXTRACTOR A `null`-safe `ToIntFunction` that returns the `PtyMode#toInt()` value and (-1) for `null`

OPOST	back to summary
public static final PtyMode OPOST Enable output processing.

PARENB	back to summary
public static final PtyMode PARENB Parity enable.

PARMRK	back to summary
public static final PtyMode PARMRK Mark parity and framing errors.

PARODD	back to summary
public static final PtyMode PARODD Odd parity, else even.

PENDIN	back to summary
public static final PtyMode PENDIN Retype pending input.

TOSTOP	back to summary
public static final PtyMode TOSTOP Stop background jobs from output.

TRUE_SETTING	back to summary
public static final Integer TRUE_SETTING

TTY_OP_END	back to summary
public static final byte TTY_OP_END

TTY_OP_ISPEED	back to summary
public static final PtyMode TTY_OP_ISPEED Specifies the input baud rate in bits per second.

TTY_OP_OSPEED	back to summary
public static final PtyMode TTY_OP_OSPEED Specifies the output baud rate in bits per second.

v	back to summary
private final int v

VDISCARD	back to summary
public static final PtyMode VDISCARD Toggles the flushing of terminal output.

VDSUSP	back to summary
public static final PtyMode VDSUSP Another suspend character.

VEOF	back to summary
public static final PtyMode VEOF End-of-file character (sends EOF from the terminal).

VEOL	back to summary
public static final PtyMode VEOL End-of-line character in addition to carriage return and/or line-feed.

VEOL2	back to summary
public static final PtyMode VEOL2 Additional end-of-line character.

VERASE	back to summary
public static final PtyMode VERASE Erase the character to left of the cursor.

VFLUSH	back to summary
public static final PtyMode VFLUSH Character to flush output.

VINTR	back to summary
public static final PtyMode VINTR Interrupt character; 255 if none. Similarly for the other characters. Not all of these characters are supported on all systems.

VKILL	back to summary
public static final PtyMode VKILL Kill the current input line.

VLNEXT	back to summary
public static final PtyMode VLNEXT Enter the next character typed literally, even if it is a special character

VQUIT	back to summary
public static final PtyMode VQUIT The quit character (sends SIGQUIT signal on POSIX systems).

VREPRINT	back to summary
public static final PtyMode VREPRINT Reprints the current input line.

VSTART	back to summary
public static final PtyMode VSTART Continues paused output (normally control-Q).

VSTATUS	back to summary
public static final PtyMode VSTATUS Prints system status line (load, command, pid, etc).

VSTOP	back to summary
public static final PtyMode VSTOP Pauses output (normally control-S).

VSUSP	back to summary
public static final PtyMode VSUSP Suspends the current program.

VSWTCH	back to summary
public static final PtyMode VSWTCH Switch to a different shell layer.

VWERASE	back to summary
public static final PtyMode VWERASE Erases a word left of cursor.

XCASE	back to summary
public static final PtyMode XCASE Enable input and output of uppercase characters by preceding their lowercase equivalents with "\".

Constructor Detail

PtyMode	back to summary
private PtyMode(int v)

Method Detail

createEnabledOptions	back to summary
public static Map<PtyMode, Integer> createEnabledOptions(PtyMode... options) Parameters options:PtyMode[] The options to enable - ignored if `null`/empty Returns:Map<PtyMode, Integer> A `Map` where all the specified `PtyMode`s have `TRUE_SETTING`

createEnabledOptions	back to summary
public static Map<PtyMode, Integer> createEnabledOptions(Collection<PtyMode> options) Parameters options:Collection<PtyMode> The options to enable - ignored if `null`/empty Returns:Map<PtyMode, Integer> A `Map` where all the specified `PtyMode`s have `TRUE_SETTING`

fromInt	back to summary
public static PtyMode fromInt(int b) Parameters b:int The numeric value of the option Returns:PtyMode The matching `PtyMode` or `null` if no match found See Also `toInt()`

fromName	back to summary
public static PtyMode fromName(String name)

getBooleanSettingValue back to summary

public static boolean getBooleanSettingValue(Map<PtyMode, ?> modes, PtyMode m)

Parameters

modes:Map<PtyMode, ?>: The current modes Map-ing
m:PtyMode: The required PtyMode

Returns:boolean

true if all of these conditions hold:

Modes map is not null/empty
Required mode setting is not null
The setting has a mapped value
The mapped value is a Number
The Number#intValue() is non-zero

See Also

getBooleanSettingValue(Object)