org.apache.sshd.common.config

Enum CompressionConfigValue

java.lang.Object

java.lang.Enum<CompressionConfigValue>

org.apache.sshd.common.config.CompressionConfigValue

All Implemented Interfaces:

Serializable, Comparable<CompressionConfigValue>, 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.

Author:

Apache MINA SSHD Project

Enum Constant Summary

Enum Constants

Enum Constant and Description
DELAYED
NO
YES

Field Summary

Fields

Modifier and Type	Field and Description
static Set<CompressionConfigValue>	VALUES

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

Method Summary

Modifier and Type	Method and Description
Compression	create()
static CompressionConfigValue	fromName(String n)
String	getName()
boolean	isCompressionExecuted()
boolean	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.
boolean	isSupported()
String	toString()
static CompressionConfigValue	valueOf(String name) 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.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.sshd.common.BuiltinFactory

setUpFactories

Methods inherited from interface org.apache.sshd.common.NamedFactory

create, setUpBuiltinFactories, setUpTransformedFactories

Methods inherited from interface org.apache.sshd.common.Factory

get

Methods inherited from interface org.apache.sshd.common.NamedResource

findByName, findFirstMatchByName, getNameList, getNames, ofName, removeByName, safeCompareByName

Methods inherited from interface org.apache.sshd.common.OptionalFeature

all, any, of

Enum Constant Detail

YES

public static final CompressionConfigValue YES

NO

public static final CompressionConfigValue NO

DELAYED

public static final CompressionConfigValue DELAYED

Field Detail

VALUES

public static final Set<CompressionConfigValue> VALUES

Method Detail

values

public static CompressionConfigValue[] 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 (CompressionConfigValue c : CompressionConfigValue.values())
    System.out.println(c);

Returns:

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

valueOf

public static CompressionConfigValue valueOf(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:

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

NullPointerException - if the argument is null

getName

public final String getName()

Specified by:

getName in interface NamedResource

Returns:

The resource name

create

public final Compression create()

Specified by:

create in interface Factory<Compression>

Returns:

A new instance

isSupported

public boolean isSupported()

Specified by:

isSupported in interface OptionalFeature

toString

public final String toString()

Overrides:

toString in class Enum<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 interface CompressionInformation

Returns:

if the compression is delayed after authentication or not

isCompressionExecuted

public boolean isCompressionExecuted()

Specified by:

isCompressionExecuted in interface CompressionInformation

Returns:

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

fromName

public static CompressionConfigValue fromName(String n)