Package ghidra.program.database
Class ProgramLinkContentHandler
- All Implemented Interfaces:
ContentHandler<ProgramDB>
,ExtensionPoint
-
Field Summary
Fields inherited from class ghidra.framework.data.LinkHandler
LINK_ICON, URL_METADATA_KEY
Fields inherited from interface ghidra.framework.data.ContentHandler
MISSING_CONTENT, UNKNOWN_CONTENT
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionlong
createFile
(FileSystem fs, FileSystem userfs, String path, String name, DomainObject obj, TaskMonitor monitor) Creates a new folder item within a specified file-system.Returns a unique content-type identifierA string that is meant to be presented to the user.Returns the name of the default tool/template that should be used to open this content type.Returns domain object implementation class supported.getIcon()
Get the base icon for this link-file which does not include the link overlay icon.Methods inherited from class ghidra.framework.data.LinkHandler
createLink, getChangeSet, getDomainObject, getImmutableObject, getMergeManager, getReadOnlyObject, getURL, isPrivateContentType
Methods inherited from class ghidra.framework.data.DBContentHandler
abortCreate, createFile
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface ghidra.framework.data.ContentHandler
canResetDBSourceFile, getLinkHandler, resetDBSourceFile
-
Field Details
-
PROGRAM_LINK_CONTENT_TYPE
- See Also:
-
-
Constructor Details
-
ProgramLinkContentHandler
public ProgramLinkContentHandler()
-
-
Method Details
-
createFile
public long createFile(FileSystem fs, FileSystem userfs, String path, String name, DomainObject obj, TaskMonitor monitor) throws IOException, InvalidNameException, CancelledException Description copied from interface:ContentHandler
Creates a new folder item within a specified file-system. If fs is versioned, the resulting item is marked as checked-out within the versioned file-system. The specified domainObj will become associated with the newly created database.- Parameters:
fs
- the file system in which to create the folder itemuserfs
- file system which contains associated user datapath
- the path of the folder itemname
- the name of the new folder itemobj
- the domain object to store in the newly created folder itemmonitor
- the monitor that allows the user to cancel- Returns:
- checkout ID for new item
- Throws:
IOException
- if an IO error occurs or an unsupporteddomainObject
implementation is specified.InvalidNameException
- if the specified name contains invalid charactersCancelledException
- if the user cancels
-
getContentType
Description copied from interface:ContentHandler
Returns a unique content-type identifier- Returns:
- content type identifier for associated domain object(s).
-
getContentTypeDisplayString
Description copied from interface:ContentHandler
A string that is meant to be presented to the user.- Returns:
- user friendly content type for associated domain object(s).
-
getDomainObjectClass
Description copied from interface:ContentHandler
Returns domain object implementation class supported.- Returns:
- implementation class for the associated
DomainObjectAdapter
implementation.
-
getIcon
Description copied from class:LinkHandler
Get the base icon for this link-file which does not include the link overlay icon.- Specified by:
getIcon
in interfaceContentHandler<ProgramDB>
- Specified by:
getIcon
in classLinkHandler<ProgramDB>
- Returns:
- base icon to be used for a
DomainFile
with the associated content type.
-
getDefaultToolName
Description copied from interface:ContentHandler
Returns the name of the default tool/template that should be used to open this content type.- Returns:
- associated default tool name for this content type
-