Package org.daiitech.naftah

Enum Class Naftah.NaftahCommand.ManualCommand.ManCommand

java.lang.Object

java.lang.Enum<Naftah.NaftahCommand.ManualCommand.ManCommand>

org.daiitech.naftah.Naftah.NaftahCommand.ManualCommand.ManCommand

All Implemented Interfaces:

Serializable, Comparable<Naftah.NaftahCommand.ManualCommand.ManCommand>, Constable

Enclosing class:

Naftah.NaftahCommand.ManualCommand

private static enum Naftah.NaftahCommand.ManualCommand.ManCommand
extends Enum<Naftah.NaftahCommand.ManualCommand.ManCommand>

Enum representing all manual subcommands supported in Naftah.

Each subcommand may have multiple aliases, supporting both English and Arabic inputs. The subcommands can be matched against user input using matches(String).

Common manual subcommands include:

• USAGE – display general usage/help instructions
• LIST_TOPICS – list all available documentation topics
• CLASSES – list all Java classes
• ACCESSIBLE_CLASSES – list accessible Java classes
• INSTANTIABLE_CLASSES – list Java classes that can be instantiated
• BUILTIN_FUNCTIONS – list built-in Naftah functions
• JVM_FUNCTIONS – list Java (JVM) functions
• EXIT – exit the manual or REPL session
• HISTORY, CURRENT_SESSION_HISTORY, SANITIZE_HISTORY, PURGE_HISTORY – manage command history (view, sanitize, or purge)

Usage example:

 if (ManCommand.USAGE.matches(input)) {
 // display help instructions
 }
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACCESSIBLE_CLASSES
BUILTIN_FUNCTIONS
CLASSES
CURRENT_SESSION_HISTORY
EXIT
HISTORY
INSTANTIABLE_CLASSES
JVM_FUNCTIONS
LIST_TOPICS
PURGE_HISTORY
SANITIZE_HISTORY
USAGE

Field Summary

Fields

Modifier and Type	Field	Description
private final Set<String>	aliases

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ManCommand(Set<String> aliases)	Constructs a manual command with the given set of aliases.

Method Summary

Modifier and Type	Method	Description
(package private) Set<String>	getAliases()	Returns the set of aliases for this manual command.
(package private) static Set<String>	getAllAliases()	Returns a set of all aliases for all manual commands.
(package private) boolean	matches(String input)	Checks if the input string matches any alias of this manual command.
static Naftah.NaftahCommand.ManualCommand.ManCommand	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Naftah.NaftahCommand.ManualCommand.ManCommand[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

USAGE

public static final Naftah.NaftahCommand.ManualCommand.ManCommand USAGE

LIST_TOPICS

public static final Naftah.NaftahCommand.ManualCommand.ManCommand LIST_TOPICS

CLASSES

public static final Naftah.NaftahCommand.ManualCommand.ManCommand CLASSES

ACCESSIBLE_CLASSES

public static final Naftah.NaftahCommand.ManualCommand.ManCommand ACCESSIBLE_CLASSES

INSTANTIABLE_CLASSES

public static final Naftah.NaftahCommand.ManualCommand.ManCommand INSTANTIABLE_CLASSES

BUILTIN_FUNCTIONS

public static final Naftah.NaftahCommand.ManualCommand.ManCommand BUILTIN_FUNCTIONS

JVM_FUNCTIONS

public static final Naftah.NaftahCommand.ManualCommand.ManCommand JVM_FUNCTIONS

EXIT

public static final Naftah.NaftahCommand.ManualCommand.ManCommand EXIT

HISTORY

public static final Naftah.NaftahCommand.ManualCommand.ManCommand HISTORY

CURRENT_SESSION_HISTORY

public static final Naftah.NaftahCommand.ManualCommand.ManCommand CURRENT_SESSION_HISTORY

SANITIZE_HISTORY

public static final Naftah.NaftahCommand.ManualCommand.ManCommand SANITIZE_HISTORY

PURGE_HISTORY

public static final Naftah.NaftahCommand.ManualCommand.ManCommand PURGE_HISTORY

Field Details

aliases

private final Set<String> aliases

Constructor Details

ManCommand

private ManCommand(Set<String> aliases)

Constructs a manual command with the given set of aliases.

Parameters:

aliases - the set of aliases for this command (English and Arabic)

Method Details

values

public static Naftah.NaftahCommand.ManualCommand.ManCommand[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Naftah.NaftahCommand.ManualCommand.ManCommand valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

matches

boolean matches(String input)

Checks if the input string matches any alias of this manual command.

Parameters:

input - the input string to check

Returns:

true if the input matches any alias, false otherwise

getAliases

Set<String> getAliases()

Returns the set of aliases for this manual command.

Returns:

the set of aliases

getAllAliases

static Set<String> getAllAliases()

Returns a set of all aliases for all manual commands.

Returns:

a Set containing all aliases