NamedResource

All Known Subinterfaces:

BuiltinFactory<T>, ChannelFactory, CheckFileHandleExtension, CheckFileNameExtension, CipherFactory, Compression, CompressionFactory, CompressionInformation, CopyDataExtension, CopyFileExtension, DHFactory, DigestFactory, ExtensionParser<T>, Identity, IoResource<T>, KexExtensionParser<T>, KeyExchange, KeyExchangeFactory, MacFactory, MD5FileExtension, MD5HandleExtension, NamedFactory<T>, OpenSSHFsyncExtension, OpenSSHKdfOptions, OpenSSHStatHandleExtension, OpenSSHStatPathExtension, Random, RandomFactory, SecurityProviderChoice, SecurityProviderRegistrar, ServiceFactory, SftpClient, SftpClientExtension, SftpClientExtensionFactory, SignatureFactory, SpaceAvailableExtension, SubsystemClient, SubsystemFactory, UserAuth, UserAuth, UserAuthFactory, UserAuthFactory, UserAuthInstance<S>, UserAuthMethodFactory<S,M>

All Known Implementing Classes:

AbstractChannelExitRequestHandler, AbstractCheckFileExtension, AbstractDHClientKeyExchange, AbstractDHKeyExchange, AbstractDHServerKeyExchange, AbstractIoResource, AbstractKexExtensionParser, AbstractMD5HashExtension, AbstractOpenSSHExtensionParser, AbstractOpenSSHExtensionParser.OpenSSHExtension, AbstractOpenSSHStatCommandExtension, AbstractParser, AbstractRandom, AbstractRandomFactory, AbstractSecurityProviderRegistrar, AbstractSftpClient, AbstractSftpClientExtension, AbstractSubsystemClient, AbstractUserAuth, AbstractUserAuth, AbstractUserAuthFactory, AbstractUserAuthFactory, AbstractUserAuthMethodFactory, AbstractUserAuthServiceFactory, AclSupportedParser, BaseCompression, BCryptKdfOptions, BouncyCastleRandom, BouncyCastleRandomFactory, BouncyCastleSecurityProviderRegistrar, BuiltinCiphers, BuiltinCompressions, BuiltinDHFactories, BuiltinDigests, BuiltinIdentities, BuiltinIoServiceFactoryFactories, BuiltinMacs, BuiltinSftpClientExtensions, BuiltinSignatures, BuiltinUserAuthFactories, BuiltinUserAuthFactories, ChannelAgentForwardingFactory, ChannelSessionFactory, CheckFileHandleExtensionImpl, CheckFileNameExtensionImpl, ClassLoaderResource, ClientConnectionServiceFactory, ClientUserAuthServiceFactory, CompressionConfigValue, CompressionDelayedZlib, CompressionNone, CompressionZlib, CopyDataExtensionImpl, CopyFileExtensionImpl, DefaultSftpClient, DelayCompression, DHGClient, DHGEXClient, DHGEXServer, DHGServer, DirectTcpipFactory, ECCurves, EdDSASecurityProviderRegistrar, Elevation, ExitSignalChannelRequestHandler, ExitStatusChannelRequestHandler, ForwardedTcpipFactory, FstatVfsExtensionParser, FsyncExtensionParser, HardLinkExtensionParser, JceRandom, JceRandomFactory, KnownHostDigest, LSetStatExtensionParser, MD5FileExtensionImpl, MD5HandleExtensionImpl, NewlineParser, NoFlowControl, OpenSSHFsyncExtensionImpl, OpenSSHStatHandleExtensionImpl, OpenSSHStatPathExtensionImpl, PathResource, PosixRenameExtensionParser, RawKdfOptions, ServerConnectionServiceFactory, ServerSignatureAlgorithms, ServerUserAuthServiceFactory, SftpFileSystem.Wrapper, SftpSubsystemFactory, SftpUniversalOwnerAndGroup, SingletonRandomFactory, SpaceAvailableExtensionImpl, StatVfsExtensionParser, Supported2Parser, SupportedParser, TcpForwardingFilter.Type, TcpipClientChannel.Type, TcpipServerChannel.TcpipFactory, URIResource, URLResource, UserAuthGSS, UserAuthGSSFactory, UserAuthHostBased, UserAuthHostBased, UserAuthHostBasedFactory, UserAuthHostBasedFactory, UserAuthKeyboardInteractive, UserAuthKeyboardInteractive, UserAuthKeyboardInteractiveFactory, UserAuthKeyboardInteractiveFactory, UserAuthNone, UserAuthNoneFactory, UserAuthPassword, UserAuthPassword, UserAuthPasswordFactory, UserAuthPasswordFactory, UserAuthPublicKey, UserAuthPublicKey, UserAuthPublicKeyFactory, UserAuthPublicKeyFactory, VendorIdParser, VersionsParser

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
```
@FunctionalInterface
public interface NamedResource
```

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.Comparator<NamedResource>`	`BY_NAME_COMPARATOR` Compares 2 `NamedResource`s according to their `getName()` value case insensitive
`static java.util.function.Function<NamedResource,java.lang.String>`	`NAME_EXTRACTOR` Returns the value of `getName()` - or `null` if argument is `null`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static <R extends NamedResource> R`	`findByName(java.lang.String name, java.util.Comparator<? super java.lang.String> c, java.util.Collection<? extends R> resources)`
`java.lang.String`	`getName()`
`static java.util.List<java.lang.String>`	`getNameList(java.util.Collection<? extends NamedResource> resources)`
`static java.lang.String`	`getNames(java.util.Collection<? extends NamedResource> resources)`
`static NamedResource`	`ofName(java.lang.String name)` Wraps a name value inside a `NamedResource`
`static <R extends NamedResource> R`	`removeByName(java.lang.String name, java.util.Comparator<? super java.lang.String> c, java.util.Collection<? extends R> resources)` Remove the resource identified by the name from the list.

- Field Detail
  - NAME_EXTRACTOR
```
static final java.util.function.Function<NamedResource,java.lang.String> NAME_EXTRACTOR
```
    Returns the value of getName() - or null if argument is null
  - BY_NAME_COMPARATOR
```
static final java.util.Comparator<NamedResource> BY_NAME_COMPARATOR
```
    Compares 2 NamedResources according to their getName() value case insensitive
- Method Detail
  - getName
```
java.lang.String getName()
```
    Returns:
    
    The resource name
  - getNameList
```
static java.util.List<java.lang.String> getNameList(java.util.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
```
static java.lang.String getNames(java.util.Collection<? extends NamedResource> resources)
```
    Parameters:
    
    resources - list of available resources
    
    Returns:
    
    A comma separated list of factory names
  - removeByName
```
static <R extends NamedResource> R removeByName(java.lang.String name,
                                                java.util.Comparator<? super java.lang.String> c,
                                                java.util.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 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
```
static <R extends NamedResource> R findByName(java.lang.String name,
                                              java.util.Comparator<? super java.lang.String> c,
                                              java.util.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 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
  - ofName
```
static NamedResource ofName(java.lang.String name)
```
    Wraps a name value inside a NamedResource
    
    Parameters:
    
    name - The name value to wrap
    
    Returns:
    
    The wrapper instance

Interface NamedResource

Field Summary

Method Summary

Field Detail

NAME_EXTRACTOR

BY_NAME_COMPARATOR

Method Detail

getName

getNameList

getNames

removeByName

findByName

ofName