jaulib v1.2.0
Jau Support Library (C++, Java, ..)
Classes | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
org.jau.fs.TraverseOptions Class Reference

Filesystem traverse options used to visit() path elements. More...

Collaboration diagram for org.jau.fs.TraverseOptions:

Classes

enum  Bit
 

Public Member Functions

 TraverseOptions (final short v)
 
 TraverseOptions ()
 
boolean isSet (final Bit bit)
 
TraverseOptions set (final Bit bit)
 Sets the given bit and returns this instance for chaining. More...
 
String toString ()
 
boolean equals (final Object other)
 

Public Attributes

short mask
 

Static Public Attributes

static final TraverseOptions none = new TraverseOptions()
 
static final TraverseOptions recursive = new TraverseOptions(TraverseOptions.Bit.recursive.value)
 

Detailed Description

Filesystem traverse options used to visit() path elements.

This enum class type fulfills C++ named requirements: BitmaskType.

See also
FileUtil::visit(FileStats, TraverseOptions, org.jau.fs.FileUtil.PathVisitor)
FileUtil::remove(String, TraverseOptions)

Definition at line 34 of file TraverseOptions.java.

Constructor & Destructor Documentation

◆ TraverseOptions() [1/2]

org.jau.fs.TraverseOptions.TraverseOptions ( final short  v)

Definition at line 68 of file TraverseOptions.java.

◆ TraverseOptions() [2/2]

org.jau.fs.TraverseOptions.TraverseOptions ( )

Definition at line 71 of file TraverseOptions.java.

Here is the caller graph for this function:

Member Function Documentation

◆ equals()

boolean org.jau.fs.TraverseOptions.equals ( final Object  other)

Definition at line 102 of file TraverseOptions.java.

Here is the call graph for this function:

◆ isSet()

boolean org.jau.fs.TraverseOptions.isSet ( final Bit  bit)

Definition at line 75 of file TraverseOptions.java.

Here is the caller graph for this function:

◆ set()

TraverseOptions org.jau.fs.TraverseOptions.set ( final Bit  bit)

Sets the given bit and returns this instance for chaining.

Parameters
bitthe given Bit value to set
Returns
this instance for chaining.

Definition at line 82 of file TraverseOptions.java.

Here is the caller graph for this function:

◆ toString()

String org.jau.fs.TraverseOptions.toString ( )

Definition at line 85 of file TraverseOptions.java.

Here is the call graph for this function:

Member Data Documentation

◆ mask

short org.jau.fs.TraverseOptions.mask

Definition at line 66 of file TraverseOptions.java.

◆ none

final TraverseOptions org.jau.fs.TraverseOptions.none = new TraverseOptions()
static

Definition at line 35 of file TraverseOptions.java.

◆ recursive

final TraverseOptions org.jau.fs.TraverseOptions.recursive = new TraverseOptions(TraverseOptions.Bit.recursive.value)
static

Definition at line 36 of file TraverseOptions.java.


The documentation for this class was generated from the following file: