Module jcifs

Class DosFileFilter

java.lang.Object
org.codelibs.jcifs.smb1.DosFileFilter
All Implemented Interfaces:
SmbFileFilter

public class DosFileFilter extends Object implements SmbFileFilter
DOS-style file filter implementation for SMB1 protocol. Filters files based on wildcard patterns and DOS file attributes.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected int
    The DOS file attributes to filter on.
    protected String
    The wildcard pattern for filtering file names.
  • Constructor Summary

    Constructors
    Constructor
    Description
    DosFileFilter(String wildcard, int attributes)
    Creates a DOS file filter with the specified wildcard and attributes.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Tests whether the specified SMB file should be included in a file list.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • wildcard

      protected String wildcard
      The wildcard pattern for filtering file names.
    • attributes

      protected int attributes
      The DOS file attributes to filter on.
  • Constructor Details

    • DosFileFilter

      public DosFileFilter(String wildcard, int attributes)
      Creates a DOS file filter with the specified wildcard and attributes. This filter can be considerably more efficient than other file filters as the specified wildcard and attributes are passed to the server for filtering there (although attributes are largely ignored by servers they are filtered locally by the default accept method).
      Parameters:
      wildcard - the wildcard pattern for matching file names (e.g., "*.txt")
      attributes - the DOS file attributes to match (e.g., ATTR_DIRECTORY)
  • Method Details

    • accept

      public boolean accept(SmbFile file) throws SmbException
      Description copied from interface: SmbFileFilter
      Tests whether the specified SMB file should be included in a file list.
      Specified by:
      accept in interface SmbFileFilter
      Parameters:
      file - the SMB file to test for inclusion
      Returns:
      true if the file should be included, false otherwise
      Throws:
      SmbException - if an error occurs while accessing the file