Top Description Fields Constructors Methods
org.apache.sshd.common.config

public final Enum CompressionConfigValue

extends Enum<CompressionConfigValue>
implements CompressionFactory
Class Inheritance
All Implemented Interfaces
org.apache.sshd.common.compression.CompressionFactory, org.apache.sshd.common.compression.CompressionInformation, org.apache.sshd.common.NamedResource, org.apache.sshd.common.BuiltinFactory, org.apache.sshd.common.OptionalFeature, org.apache.sshd.common.NamedFactory, org.apache.sshd.common.Factory, java.util.function.Supplier
Imports
java.util.Collections, .EnumSet, .Set, org.apache.sshd.common.compression.BuiltinCompressions, .Compression, .CompressionFactory, org.apache.sshd.common.util.GenericUtils
Provides a "bridge" between the configuration values and the actual org.apache.sshd.common.NamedFactory for the Compression.
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
public static final CompressionConfigValue
DELAYED

private final CompressionFactory
factory

public static final CompressionConfigValue
NO

public static final Set<CompressionConfigValue>
VALUES

public static final CompressionConfigValue
YES

Constructor Summary

AccessConstructor and Description
private
CompressionConfigValue(CompressionFactory delegate)

Method Summary

Modifier and TypeMethod and Description
public final Compression
create()

Implements org.apache.sshd.common.Factory.create.

public static CompressionConfigValue
fromName(String n)

public final String
getName()

Implements org.apache.sshd.common.NamedResource.getName.

public boolean
isCompressionExecuted()

Implements org.apache.sshd.common.compression.CompressionInformation.isCompressionExecuted.

public boolean
isDelayed()

Implements org.apache.sshd.common.compression.CompressionInformation.isDelayed.

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.

public boolean
isSupported()

Implements org.apache.sshd.common.OptionalFeature.isSupported.

public final String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.

public static CompressionConfigValue
valueOf(String name)

public static CompressionConfigValue[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

DELAYEDback to summary
public static final CompressionConfigValue DELAYED
factoryback to summary
private final CompressionFactory factory
NOback to summary
public static final CompressionConfigValue NO
VALUESback to summary
public static final Set<CompressionConfigValue> VALUES
YESback to summary
public static final CompressionConfigValue YES

Constructor Detail

CompressionConfigValueback to summary
private CompressionConfigValue(CompressionFactory delegate)

Method Detail

createback to summary
public final Compression create()

Implements org.apache.sshd.common.Factory.create.

Returns:Compression

Doc from org.apache.sshd.common.Factory.create.

A new instance

Annotations
@Override
fromNameback to summary
public static CompressionConfigValue fromName(String n)
getNameback to summary
public final String getName()

Implements org.apache.sshd.common.NamedResource.getName.

Returns:String

Doc from org.apache.sshd.common.NamedResource.getName.

The resource name

Annotations
@Override
isCompressionExecutedback to summary
public boolean isCompressionExecuted()

Implements org.apache.sshd.common.compression.CompressionInformation.isCompressionExecuted.

Returns:boolean

Doc from org.apache.sshd.common.compression.CompressionInformation.isCompressionExecuted.

true if there is any compression executed by this "compressor" - special case for 'none'

Annotations
@Override
isDelayedback to summary
public boolean isDelayed()

Implements org.apache.sshd.common.compression.CompressionInformation.isDelayed.

Doc from org.apache.sshd.common.compression.CompressionInformation.isDelayed.

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.

Returns:boolean

if the compression is delayed after authentication or not

Annotations
@Override
isSupportedback to summary
public boolean isSupported()

Implements org.apache.sshd.common.OptionalFeature.isSupported.

Annotations
@Override
toStringback to summary
public final String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations
@Override
valueOfback to summary
public static CompressionConfigValue valueOf(String name)
valuesback to summary
public static CompressionConfigValue[] values()