public enum BuiltinCompressions extends Enum<BuiltinCompressions> implements CompressionFactory
Modifier and Type | Class and Description |
---|---|
static class |
BuiltinCompressions.Constants |
static class |
BuiltinCompressions.ParseResult
Holds the result of
parseCompressionsList(String) |
BuiltinFactory.Utils
Enum Constant and Description |
---|
delayedZlib |
none |
zlib |
Modifier and Type | Field and Description |
---|---|
static Set<BuiltinCompressions> |
VALUES |
BY_NAME_COMPARATOR, NAME_EXTRACTOR
FALSE, TRUE
Modifier and Type | Method and Description |
---|---|
static BuiltinCompressions |
fromFactoryName(String name) |
String |
getName() |
static SortedSet<CompressionFactory> |
getRegisteredExtensions() |
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() |
static BuiltinCompressions.ParseResult |
parseCompressionsList(Collection<String> compressions) |
static BuiltinCompressions.ParseResult |
parseCompressionsList(String... compressions) |
static BuiltinCompressions.ParseResult |
parseCompressionsList(String compressions) |
static void |
registerExtension(CompressionFactory extension)
Registered a
NamedFactory to be available besides the built-in
ones when parsing configuration |
static CompressionFactory |
resolveFactory(String name) |
String |
toString() |
static CompressionFactory |
unregisterExtension(String name)
Unregisters specified extension
|
static BuiltinCompressions |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static BuiltinCompressions[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final BuiltinCompressions none
public static final BuiltinCompressions zlib
public static final BuiltinCompressions delayedZlib
public static final Set<BuiltinCompressions> VALUES
public static BuiltinCompressions[] values()
for (BuiltinCompressions c : BuiltinCompressions.values()) System.out.println(c);
public static BuiltinCompressions valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic final String getName()
getName
in interface NamedResource
public boolean isDelayed()
CompressionInformation
isDelayed
in interface CompressionInformation
public boolean isCompressionExecuted()
isCompressionExecuted
in interface CompressionInformation
true
if there is any compression executed by
this "compressor" - special case for 'none'public final String toString()
toString
in class Enum<BuiltinCompressions>
public final boolean isSupported()
isSupported
in interface OptionalFeature
public static void registerExtension(CompressionFactory extension)
NamedFactory
to be available besides the built-in
ones when parsing configurationextension
- The factory to registerIllegalArgumentException
- if factory instance is null
,
or overrides a built-in one or overrides another registered factory
with the same name (case insensitive).public static SortedSet<CompressionFactory> getRegisteredExtensions()
SortedSet
of the currently registered extensions, sorted
according to the factory name (case insensitive)public static CompressionFactory unregisterExtension(String name)
name
- The factory name - ignored if null
/emptynull
if not foundpublic static BuiltinCompressions fromFactoryName(String name)
public static BuiltinCompressions.ParseResult parseCompressionsList(String compressions)
compressions
- A comma-separated list of Compressions' names - ignored
if null
/emptyBuiltinCompressions.ParseResult
containing the successfully parsed
factories and the unknown ones. Note: it is up to caller to
ensure that the lists do not contain duplicatespublic static BuiltinCompressions.ParseResult parseCompressionsList(String... compressions)
public static BuiltinCompressions.ParseResult parseCompressionsList(Collection<String> compressions)
public static CompressionFactory resolveFactory(String name)
name
- The factory namenull
if it is neither a built-in one
or a registered extensionCopyright © 2008–2016 The Apache Software Foundation. All rights reserved.