Package org.apache.sshd.common.config
Enum CompressionConfigValue
- All Implemented Interfaces:
Serializable
,Comparable<CompressionConfigValue>
,java.lang.constant.Constable
,Supplier<Compression>
,BuiltinFactory<Compression>
,CompressionFactory
,CompressionInformation
,Factory<Compression>
,NamedFactory<Compression>
,NamedResource
,OptionalFeature
public enum CompressionConfigValue
extends Enum<CompressionConfigValue>
implements CompressionFactory
Provides a "bridge" between the configuration values and the actual
NamedFactory
for the Compression
.-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final CompressionFactory
static final Set
<CompressionConfigValue> Fields inherited from interface org.apache.sshd.common.NamedResource
BY_NAME_COMPARATOR, NAME_EXTRACTOR
Fields inherited from interface org.apache.sshd.common.OptionalFeature
FALSE, TRUE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal Compression
create()
static CompressionConfigValue
final String
getName()
boolean
boolean
Delayed compression is an Open-SSH specific feature which informs both the client and server to not compress data before the session has been authenticated.boolean
final String
toString()
static CompressionConfigValue
Returns the enum constant of this type with the specified name.static CompressionConfigValue[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
YES
-
NO
-
DELAYED
-
-
Field Details
-
VALUES
-
factory
-
-
Constructor Details
-
CompressionConfigValue
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getName
- Specified by:
getName
in interfaceNamedResource
- Returns:
- The resource name
-
create
- Specified by:
create
in interfaceFactory<Compression>
- Returns:
- A new instance
-
isSupported
public boolean isSupported()- Specified by:
isSupported
in interfaceOptionalFeature
-
toString
- Overrides:
toString
in classEnum<CompressionConfigValue>
-
isDelayed
public boolean isDelayed()Description copied from interface:CompressionInformation
Delayed compression is an Open-SSH specific feature which informs both the client and server to not compress data before the session has been authenticated.- Specified by:
isDelayed
in interfaceCompressionInformation
- Returns:
- if the compression is delayed after authentication or not
-
isCompressionExecuted
public boolean isCompressionExecuted()- Specified by:
isCompressionExecuted
in interfaceCompressionInformation
- Returns:
true
if there is any compression executed by this "compressor" - special case for 'none'
-
fromName
-