Package com.j3d.engine.interact.cmd.args

Interface Argument

All Known Implementing Classes:
AbstractTransform, AreaCmd, ArgSet, CameraInfoCmd, CopyCmd, DistanceCmd, EchoCmd, EndCmd, ExitCmd, FilesCmd, LineJoin, ListCmd, LookAtCmd, OrbitCmd, PasteCmd, QuickTranslateCmd, RandomUUIDCmd, RecordCmd, RotateSelection, RunCmd, ScaleSelection, Subcommand, TeleportCmd, TestCmd, ToggleCmd, ToggleVisCmd, TranslateSelection, TriangleCmd, TypedArg, TypeOf, VolumeCmd
public interface Argument
Defines the contract for a command argument in the command processing system.

An Argument represents a parameter that can be passed to a command, complete with its name, a description for help menus, and whether it is required or optional. This interface is the base for more specific argument types, such as ArgSet.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Provides a user-friendly description of what the argument does.
    String
    getName()
    Returns the name of the argument.
    boolean
    isOptional()
    Specifies whether the argument is optional or required for the command to execute.

  • Method Details

    • getName

      String getName()
      Returns the name of the argument.

      This is the identifier used by the command parser to refer to this argument.

      Returns:
      The name of the argument.

    • getDescription

      String getDescription()
      Provides a user-friendly description of what the argument does.

      This is typically used for generating help text or tooltips.

      Returns:
      A brief description of the argument's purpose.

    • isOptional

      boolean isOptional()
      Specifies whether the argument is optional or required for the command to execute.
      Returns:
      true if the argument is optional, false if it is required.