ScanConductor.ScanAction (Apache Maven Shared Utils 0.7 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

org.apache.maven.shared.utils.io
Enum ScanConductor.ScanAction

java.lang.Object
  java.lang.Enum<ScanConductor.ScanAction>
      org.apache.maven.shared.utils.io.ScanConductor.ScanAction

All Implemented Interfaces:: Serializable, Comparable<ScanConductor.ScanAction>

Enclosing interface:: ScanConductor

public static enum ScanConductor.ScanAction
extends Enum<ScanConductor.ScanAction>
extends Enum<ScanConductor.ScanAction>

Enum Constant Summary
`ABORT` Abort the whole scanning process.
`ABORT_DIRECTORY` Abort processing the current directory.
`CONTINUE` Continue the scanning with the next item in the list.
`NO_RECURSE` This response is only valid for `ScanConductor.visitDirectory(String, java.io.File)`.

Method Summary
`static ScanConductor.ScanAction`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ScanConductor.ScanAction[]`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum
`clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`finalize, getClass, notify, notifyAll, wait, wait, wait`

Enum Constant Detail

ABORT

public static final ScanConductor.ScanAction ABORT

Abort the whole scanning process. The current file will not be added anymore.

CONTINUE

public static final ScanConductor.ScanAction CONTINUE

Continue the scanning with the next item in the list.

NO_RECURSE

public static final ScanConductor.ScanAction NO_RECURSE

This response is only valid for ScanConductor.visitDirectory(String, java.io.File). Do not recurse into the current directory. The current directory will not be added and the processing will be continued with the next item in the list.

ABORT_DIRECTORY

public static final ScanConductor.ScanAction ABORT_DIRECTORY

Abort processing the current directory. The current file will not be added. The processing will continue it's scan in the parent directory if any.

Method Detail

values

public static final ScanConductor.ScanAction[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(ScanConductor.ScanAction c : ScanConductor.ScanAction.values())
        System.out.println(c);

Returns:: an array containing the constants of this enum type, in the order they're declared

valueOf

public static ScanConductor.ScanAction valueOf(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:: IllegalArgumentException - if this enum type has no constant with the specified name