org.apache.sshd.common

Class NamedResource.Utils

java.lang.Object

org.apache.sshd.common.NamedResource.Utils

Enclosing interface:

NamedResource

public static final class NamedResource.Utils
extends Object

Utility class to help using NamedResources

Method Summary

Modifier and Type	Method and Description
static <R extends NamedResource> R	findByName(String name, Comparator<? super String> c, Collection<? extends R> resources)
static List<String>	getNameList(Collection<? extends NamedResource> resources)
static String	getNames(Collection<? extends NamedResource> resources)
static <R extends NamedResource> R	removeByName(String name, Comparator<? super String> c, Collection<? extends R> resources) Remove the resource identified by the name from the list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getNameList

public static List<String> getNameList(Collection<? extends NamedResource> resources)

Parameters:

resources - The named resources

Returns:

A List of all the factories names - in same order as they appear in the input collection

getNames

public static String getNames(Collection<? extends NamedResource> resources)

Parameters:

resources - list of available resources

Returns:

A comma separated list of factory names

removeByName

public static <R extends NamedResource> R removeByName(String name,
                                                       Comparator<? super String> c,
                                                       Collection<? extends R> resources)

Remove the resource identified by the name from the list.

Type Parameters:

R - The generic resource type

Parameters:

name - Name of the resource - ignored if null/empty

c - The Comparator to decide whether the NamedResource.getName() matches the name parameter

resources - The NamedResource to check - ignored if null/empty

Returns:

the removed resource from the list or null if not in the list

findByName

public static <R extends NamedResource> R findByName(String name,
                                                     Comparator<? super String> c,
                                                     Collection<? extends R> resources)

Type Parameters:

R - The generic resource type

Parameters:

name - Name of the resource - ignored if null/empty

c - The Comparator to decide whether the NamedResource.getName() matches the name parameter

resources - The NamedResource to check - ignored if null/empty

Returns:

The first resource whose name matches the parameter (by invoking Comparator.compare(Object, Object) - null if no match found