Module openj9.dtfj
Package com.ibm.j9ddr.tools.ddrinteractive

Interface ICommand

All Known Implementing Classes:
ACCommand, AllClassesCommand, AnalyseRomClassUTF8Command, BaseStructureCommand, BuildFlagsCommand, BytecodesCommand, ClassForNameCommand, ClassloadersSummaryCommand, Command, CompressedRefMappingCommand, ContinuationStackWalkCommand, CoreInfoCommand, CPDescriptionCommand, DDRInteractive.ContextCommand, DDRInteractive.J9HelpCommand, DumpAllClassesInModuleCommand, DumpAllClassloadersCommand, DumpAllRamClassLinearCommand, DumpAllRegionsCommand, DumpAllRomClassLinearCommand, DumpAllSegmentsCommand, DumpContendedLoadTable, DumpModuleCommand, DumpModuleDirectedExportsCommand, DumpModuleExportsCommand, DumpModuleReadsCommand, DumpPackageCommand, DumpRamClassLinearCommand, DumpRomClassCommand, DumpRomClassLinearCommand, DumpRomMethodCommand, DumpSegmentsInListCommand, DumpSegregatedStatsCommand, DumpStringTableCommand, ExtendedMethodFlagInfoCommand, ExtractMemoryCommand, FindAllModulesCommand, FindAllReadsCommand, FindInMemoryCommand, FindInstances, FindMethodFromPcCommand, FindModuleByNameCommand, FindModulesCommand, FindOverlappingSegmentsCommand, FindPatternCommand, FindStackValueCommand, FindVMCommand, FlatObjectCommand, ForeachCommand, GCCheckCommand, GpInfoCommand, HashCodeCommand, ITableSizeCommand, J9ClassShapeCommand, J9ConstantPoolCommand, J9MemTagCommands, J9StaticsCommand, J9VTablesCommand, J9XCommand, JextractCommand, JitMetadataFromPcCommand, JitstackCommand, LocalMapCommand, LookupSymbolCommand, MarkMapCommand, MemoryRangesCommand, MethodForNameCommand, MonitorsCommand, NativeLibrariesCommand, NativeMemInfoCommand, NativeStacksCommand, ObjectRefsCommand, ObjectSizeInfo, PluginCommand, QueryRomClassCommand, RamClassSummaryCommand, RomClassForNameCommand, RomClassSummaryCommand, RootPathCommand, RuntimeSettingsCommand, SearchStringTableCommand, SetVMCommand, ShowDumpAgentsCommand, ShrCCommand, SnapBaseCommand, SnapFormatCommand, SnapFormatWrapperCommand, SnapTraceCommand, StackmapCommand, StackWalkCommand, StructureCommand, ThreadsCommand, TimeCommand, TraceConfigCommand, TrPrintCommand, ValidateTraceFreeQueueCommand, VirtualThreadsCommand, VmCheckCommand, VMConstantPoolCommand, WalkInternTableCommand, WalkJ9PoolCommand, WalkUtThreadDataCommand, WhatIsCommand
public interface ICommand
Interface for DDR Interactive commands.

  • Method Details

    • recognises

      boolean recognises(String command, Context context)
      Method used by the DDR Interactive engine to decide whether this command matches the command passed in by the user
      Parameters:
      command - Command string entered by user. e.g. !j9x
      context - Current DDRInteractive context
      Returns:
      True if this command object can process the supplied command (in which case the DDR engine will then call run())

    • run

      void run(String command, String[] args, Context context, PrintStream out) throws DDRInteractiveCommandException
      Executes the command
      Parameters:
      command - Command string e.g. !j9x
      args - Arguments for command
      context - Context to work in
      out - PrintStream to write command output on
      Throws:
      DDRInteractiveCommandException - If there is any problem running the command (incorrect usage, CorruptData etc.)

    • getCommandDescriptions

      Collection<String> getCommandDescriptions()
      Returns:
      Strings to be inserted in !j9help output

    • getCommandNames

      Collection<String> getCommandNames()
      Returns:
      Strings containing command names