java.lang.Object
com.ibm.j9ddr.tools.ddrinteractive.Command
- All Implemented Interfaces:
ICommand
- Direct Known Subclasses:
ACCommand,AllClassesCommand,AnalyseRomClassUTF8Command,BuildFlagsCommand,BytecodesCommand,ClassForNameCommand,ClassloadersSummaryCommand,CompressedRefMappingCommand,ContinuationStackWalkCommand,CoreInfoCommand,CPDescriptionCommand,DDRInteractive.ContextCommand,DDRInteractive.J9HelpCommand,DumpAllClassesInModuleCommand,DumpAllClassloadersCommand,DumpAllOffHeapEntriesCommand,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,SnapFormatWrapperCommand,StackmapCommand,StackWalkCommand,ThreadsCommand,TimeCommand,TraceConfigCommand,TrPrintCommand,ValidateTraceFreeQueueCommand,VirtualThreadsCommand,VmCheckCommand,VMConstantPoolCommand,WalkInternTableCommand,WalkJ9PoolCommand,WalkUtThreadDataCommand,WhatIsCommand
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddCommand(String name, String argDescription, String helpDescription) voidaddSubCommand(Command.CommandDescription command, String name, String argDescription, String helpDescription) protected longdbgFindPatternInRange(Context context, byte[] pattern, int patternAlignment, long startSearchFrom, BigInteger bytesToSearch) voidThis prints the detailed help for the command by listing all the names that this command can be invoked by and also any sub commands that have been defined.booleanrecognises(String command, Context context) Method used by the DDR Interactive engine to decide whether this command matches the command passed in by the user
-
Field Details
-
nl
-
-
Constructor Details
-
Command
public Command()
-
-
Method Details
-
addCommand
public Command.CommandDescription addCommand(String name, String argDescription, String helpDescription) - Parameters:
name- Command NameargDescription- Brief name of any optional or required argumentshelpDescription- One-liner Description of the command argDescription should be a word describing the argument name. e.g: to specify an address argument that is mandatory [address] to specify an address argument that is optional
-
addSubCommand
public void addSubCommand(Command.CommandDescription command, String name, String argDescription, String helpDescription) -
recognises
Description copied from interface:ICommandMethod used by the DDR Interactive engine to decide whether this command matches the command passed in by the user- Specified by:
recognisesin interfaceICommand- Parameters:
command- Command string entered by user. e.g. !j9xcontext- Current DDRInteractive context- Returns:
- True if this command object can process the supplied command (in which case the DDR engine will then call run())
-
getCommandDescriptions
- Specified by:
getCommandDescriptionsin interfaceICommand- Returns:
- Strings to be inserted in !j9help output
-
getCommandNames
- Specified by:
getCommandNamesin interfaceICommand- Returns:
- Strings containing command names
-
printDetailedHelp
This prints the detailed help for the command by listing all the names that this command can be invoked by and also any sub commands that have been defined.- Parameters:
out- stream to write the output on
-
dbgFindPatternInRange
protected long dbgFindPatternInRange(Context context, byte[] pattern, int patternAlignment, long startSearchFrom, BigInteger bytesToSearch) throws MemoryFault - Throws:
MemoryFault
-