org.apache.sshd.common.digest

Enum BuiltinDigests

java.lang.Object

java.lang.Enum<BuiltinDigests>

org.apache.sshd.common.digest.BuiltinDigests

All Implemented Interfaces:

Serializable, Comparable<BuiltinDigests>, Supplier<Digest>, AlgorithmNameProvider, DigestFactory, DigestInformation, Factory<Digest>, NamedFactory<Digest>, NamedResource, OptionalFeature

public enum BuiltinDigests
extends Enum<BuiltinDigests>
implements DigestFactory

Provides easy access to the currently implemented digests

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BuiltinDigests.Constants

Enum Constant Summary

Enum Constants

Enum Constant and Description
md5
sha1
sha224
sha256
sha384
sha512

Field Summary

Fields

Modifier and Type	Field and Description
static Set<BuiltinDigests>	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
Digest	create()
static BuiltinDigests	fromAlgorithm(String algo)
static BuiltinDigests	fromDigest(Digest d)
static BuiltinDigests	fromFactory(NamedFactory<? extends Digest> factory)
static BuiltinDigests	fromFactoryName(String name)
static BuiltinDigests	fromString(String s)
String	getAlgorithm()
int	getBlockSize()
String	getName()
boolean	isSupported()
String	toString()
static BuiltinDigests	valueOf(String name) Returns the enum constant of this type with the specified name.
static BuiltinDigests[]	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.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

md5

public static final BuiltinDigests md5

sha1

public static final BuiltinDigests sha1

sha224

public static final BuiltinDigests sha224

sha256

public static final BuiltinDigests sha256

sha384

public static final BuiltinDigests sha384

sha512

public static final BuiltinDigests sha512

Field Detail

VALUES

public static final Set<BuiltinDigests> VALUES

Method Detail

values

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

Returns:

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

valueOf

public static BuiltinDigests 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

getAlgorithm

public final String getAlgorithm()

Specified by:

getAlgorithm in interface AlgorithmNameProvider

getBlockSize

public final int getBlockSize()

Specified by:

getBlockSize in interface DigestInformation

Returns:

The number of bytes in the digest's output

toString

public final String toString()

Overrides:

toString in class Enum<BuiltinDigests>

create

public final Digest create()

Specified by:

create in interface Factory<Digest>

Returns:

A new instance

isSupported

public final boolean isSupported()

Specified by:

isSupported in interface OptionalFeature

fromString

public static BuiltinDigests fromString(String s)

Parameters:

s - The Enum's name - ignored if null/empty

Returns:

The matching BuiltinDigests whose Enum.name() matches (case insensitive) the provided argument - null if no match

fromFactory

public static BuiltinDigests fromFactory(NamedFactory<? extends Digest> factory)

Parameters:

factory - The NamedFactory for the cipher - ignored if null

Returns:

The matching BuiltinDigests whose factory name matches (case insensitive) the digest factory name

See Also:

fromFactoryName(String)

fromFactoryName

public static BuiltinDigests fromFactoryName(String name)

Parameters:

name - The factory name - ignored if null/empty

Returns:

The matching BuiltinDigests whose factory name matches (case insensitive) the provided name - null if no match

fromDigest

public static BuiltinDigests fromDigest(Digest d)

Parameters:

d - The Digest instance - ignored if null

Returns:

The matching BuiltinDigests whose algorithm matches (case insensitive) the digets's algorithm - null if no match

fromAlgorithm

public static BuiltinDigests fromAlgorithm(String algo)

Parameters:

algo - The algorithm to find - ignored if null/empty

Returns:

The matching BuiltinDigests whose algorithm matches (case insensitive) the provided name - null if no match