Filesystem traverse event used to call path_visitor for path elements from visit(). More...

Collaboration diagram for org.jau.fs.TraverseEvent:

Public Member Functions
	TraverseEvent (final short v)

Public Attributes
	none =( (short) 0 )
	No value, neither file, symlink nor dir_entry or dir_exit. More...

	symlink =( (short) (1 << 0) )
	Visiting a symbolic-link, either to a file or a non-existing entity. More...

	file =( (short) (1 << 1) )
	Visiting a file, may be in conjunction with symlink, i.e. More...

	file_symlink =( (short) ( 1 << 0 \| 1 << 1 ) )
	Visiting a symlink to a file, i.e. More...

	dir_symlink =( (short) (1 << 2) )
	Visiting a symbolic-link to a directory which is not followed, i.e. More...

	dir_check_entry =( (short) (1 << 7) )
	Visiting a directory on entry, see traverse_options::dir_check_entry. More...

	dir_entry =( (short) (1 << 8) )
	Visiting a directory on entry, see traverse_options::dir_entry. More...

	dir_exit =( (short) (1 << 9) )
	Visiting a directory on exit, see traverse_options::dir_exit. More...

	dir_non_recursive =( (short) ( 1 << 8 \| 1 << 9 ) )
	Visiting a directory non-recursive, i.e. More...

final short	value

Detailed Description

Filesystem traverse event used to call path_visitor for path elements from visit().

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

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

Definition at line 34 of file TraverseEvent.java.

Constructor & Destructor Documentation

◆ TraverseEvent()

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

Definition at line 93 of file TraverseEvent.java.

Member Data Documentation

◆ dir_check_entry

org.jau.fs.TraverseEvent.dir_check_entry =( (short) (1 << 7) )

Visiting a directory on entry, see traverse_options::dir_check_entry.

This allows the path_visitor to deny traversal into the directory by returning false, otherwise continuing traversal.

Definition at line 62 of file TraverseEvent.java.

◆ dir_entry

org.jau.fs.TraverseEvent.dir_entry =( (short) (1 << 8) )

Visiting a directory on entry, see traverse_options::dir_entry.

If a directory is visited non-recursive, i.e. traverse_options::recursive not set, dir_entry and dir_exit are set, see dir_non_recursive.

If a directory is a symbolic link which is not followed, i.e. traverse_options::follow_symlinks not set, dir_symlink is used instead.

Definition at line 73 of file TraverseEvent.java.

◆ dir_exit

org.jau.fs.TraverseEvent.dir_exit =( (short) (1 << 9) )

Visiting a directory on exit, see traverse_options::dir_exit.

If a directory is visited non-recursive, i.e. traverse_options::recursive not set, dir_entry and dir_exit are set, see dir_non_recursive.

If a directory is a symbolic link which is not followed, i.e. traverse_options::follow_symlinks not set, dir_symlink is used instead.

Definition at line 84 of file TraverseEvent.java.

◆ dir_non_recursive

org.jau.fs.TraverseEvent.dir_non_recursive =( (short) ( 1 << 8 | 1 << 9 ) )

Visiting a directory non-recursive, i.e.

traverse_options::recursive not set.

Value is a bit-mask of dir_entry | dir_exit

Definition at line 91 of file TraverseEvent.java.

◆ dir_symlink

org.jau.fs.TraverseEvent.dir_symlink =( (short) (1 << 2) )

Visiting a symbolic-link to a directory which is not followed, i.e.

traverse_options::follow_symlinks not set.

Definition at line 54 of file TraverseEvent.java.

◆ file

org.jau.fs.TraverseEvent.file =( (short) (1 << 1) )

Visiting a file, may be in conjunction with symlink, i.e.

file_symlink

Definition at line 46 of file TraverseEvent.java.

◆ file_symlink

org.jau.fs.TraverseEvent.file_symlink =( (short) ( 1 << 0 | 1 << 1 ) )

Visiting a symlink to a file, i.e.

symlink | file

Definition at line 49 of file TraverseEvent.java.

◆ none

org.jau.fs.TraverseEvent.none =( (short) 0 )

No value, neither file, symlink nor dir_entry or dir_exit.

Implying an error state in file_stat, e.g. !file_stats::has_access().

Definition at line 36 of file TraverseEvent.java.

◆ symlink

org.jau.fs.TraverseEvent.symlink =( (short) (1 << 0) )

Visiting a symbolic-link, either to a file or a non-existing entity.

Not followed symbolic-links to a directory is expressed via dir_symlink.

In case of a symbolic-link to an existing file, file is also set, i.e. file_symlink.

Definition at line 43 of file TraverseEvent.java.

◆ value

final short org.jau.fs.TraverseEvent.value

Definition at line 94 of file TraverseEvent.java.

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

java_jni/org/jau/fs/TraverseEvent.java

Public Member Functions

Public Attributes