Enum BuiltinCompressions

    • Field Detail

      • EXTENSIONS

        private static final java.util.Map<java.lang.String,​CompressionFactory> EXTENSIONS
      • name

        private final java.lang.String name
    • Constructor Detail

      • BuiltinCompressions

        private BuiltinCompressions​(java.lang.String n)
    • Method Detail

      • values

        public static BuiltinCompressions[] 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 (BuiltinCompressions c : BuiltinCompressions.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static BuiltinCompressions valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getName

        public final java.lang.String getName()
        Specified by:
        getName in interface NamedResource
        Returns:
        The resource name
      • isDelayed

        public boolean isDelayed()
        Description copied from interface: CompressionInformation
        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.
        Specified by:
        isDelayed in interface CompressionInformation
        Returns:
        if the compression is delayed after authentication or not
      • isCompressionExecuted

        public boolean isCompressionExecuted()
        Specified by:
        isCompressionExecuted in interface CompressionInformation
        Returns:
        true if there is any compression executed by this "compressor" - special case for 'none'
      • toString

        public final java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<BuiltinCompressions>
      • registerExtension

        public static void registerExtension​(CompressionFactory extension)
        Registered a NamedFactory to be available besides the built-in ones when parsing configuration
        Parameters:
        extension - The factory to register
        Throws:
        java.lang.IllegalArgumentException - if factory instance is null, or overrides a built-in one or overrides another registered factory with the same name (case insensitive).
      • getRegisteredExtensions

        public static java.util.NavigableSet<CompressionFactory> getRegisteredExtensions()
        Returns:
        A SortedSet of the currently registered extensions, sorted according to the factory name (case insensitive)
      • unregisterExtension

        public static CompressionFactory unregisterExtension​(java.lang.String name)
        Unregisters specified extension
        Parameters:
        name - The factory name - ignored if null/empty
        Returns:
        The registered extension - null if not found
      • fromFactoryName

        public static BuiltinCompressions fromFactoryName​(java.lang.String name)
      • parseCompressionsList

        public static BuiltinCompressions.ParseResult parseCompressionsList​(java.lang.String compressions)
        Parameters:
        compressions - A comma-separated list of Compressions' names - ignored if null/empty
        Returns:
        A BuiltinCompressions.ParseResult containing the successfully parsed factories and the unknown ones. Note: it is up to caller to ensure that the lists do not contain duplicates
      • resolveFactory

        public static CompressionFactory resolveFactory​(java.lang.String name)
        Parameters:
        name - The factory name
        Returns:
        The factory or null if it is neither a built-in one or a registered extension