Apache Mina SSHD 2.15.0 · org.apache.sshd.common.NamedFactory

Method Summary

Modifier and Type	Method and Description
public static < type of object to create T> T	Returns: a newly created object or `null` if the factory is not in the list create(Collection<? extends NamedFactory<? extends T>> list of available factories factories, String the factory name to use name) Create an instance of the specified name by looking up the needed factory in the list.
public static < factory type E extends NamedResource & OptionalFeature> List<E>	Returns: the filtered list of factories setUpBuiltinFactories(boolean whether to filter out unsupported factories from `preferred` ignoreUnsupported, Collection<? extends E> initial list to filter preferred) Filters out unsupported factories from a given list if `ignoreUnsupported == true`.
public static < initial factory type S extends OptionalFeature, transformed factory type E extends NamedResource> List<E>	Returns: the filtered list of transformed factories setUpTransformedFactories(boolean whether to filter out unsupported factories from `preferred` ignoreUnsupported, Collection<? extends S> initial list to filter preferred, Function<? super S, ? extends E> the transformation to apply xform) Converts a list of factories to a list of transformed factories, optionally excluding unsupported factories.

Inherited from org.apache.sshd.common.Factory:: create get
Inherited from org.apache.sshd.common.NamedResource:: findByName findFirstMatchByName getName getNameList getNames ofName removeByName safeCompareByName

Method Detail

create back to summary

create	back to summary
public static <T> T create(Collection<? extends NamedFactory<? extends T>> factories, String name) Create an instance of the specified name by looking up the needed factory in the list. Parameters <T> type of object to create factories:Collection<? extends NamedFactory<? extends T>> list of available factories name:String the factory name to use Returns:T a newly created object or `null` if the factory is not in the list

public static <T> T create(Collection<? extends NamedFactory<? extends T>> factories, String name)

Create an instance of the specified name by looking up the needed factory in the list.

Parameters

<T>: type of object to create
factories:Collection<? extends NamedFactory<? extends T>>: list of available factories
name:String: the factory name to use

Returns:T

a newly created object or null if the factory is not in the list

setUpBuiltinFactories back to summary

setUpBuiltinFactories	back to summary
public static <E extends NamedResource & OptionalFeature> List<E> setUpBuiltinFactories(boolean ignoreUnsupported, Collection<? extends E> preferred) Filters out unsupported factories from a given list if `ignoreUnsupported == true`. Parameters <E> factory type ignoreUnsupported:boolean whether to filter out unsupported factories from `preferred` preferred:Collection<? extends E> initial list to filter Returns:List<E> the filtered list of factories

public static <E extends NamedResource & OptionalFeature> List<E> setUpBuiltinFactories(boolean ignoreUnsupported, Collection<? extends E> preferred)

Filters out unsupported factories from a given list if ignoreUnsupported == true.

Parameters

<E>: factory type
ignoreUnsupported:boolean: whether to filter out unsupported factories from preferred
preferred:Collection<? extends E>: initial list to filter

Returns:List<E>

the filtered list of factories

setUpTransformedFactories back to summary

setUpTransformedFactories	back to summary
public static <S extends OptionalFeature, E extends NamedResource> List<E> setUpTransformedFactories(boolean ignoreUnsupported, Collection<? extends S> preferred, Function<? super S, ? extends E> xform) Converts a list of factories to a list of transformed factories, optionally excluding unsupported factories. Parameters <S> initial factory type <E> transformed factory type ignoreUnsupported:boolean whether to filter out unsupported factories from `preferred` preferred:Collection<? extends S> initial list to filter xform:Function<? super S, ? extends E> the transformation to apply Returns:List<E> the filtered list of transformed factories

public static <S extends OptionalFeature, E extends NamedResource> List<E> setUpTransformedFactories(boolean ignoreUnsupported, Collection<? extends S> preferred, Function<? super S, ? extends E> xform)

Converts a list of factories to a list of transformed factories, optionally excluding unsupported factories.

Parameters

<S>: initial factory type
<E>: transformed factory type
ignoreUnsupported:boolean: whether to filter out unsupported factories from preferred
preferred:Collection<? extends S>: initial list to filter
xform:Function<? super S, ? extends E>: the transformation to apply

Returns:List<E>

the filtered list of transformed factories

public Interface NamedFactory<T>

Field Summary

Method Summary

Method Detail