Package ghidra.framework.data

Class URLLinkObject

java.lang.Object

ghidra.framework.data.DomainObjectAdapter

ghidra.framework.data.DomainObjectAdapterDB

ghidra.framework.data.URLLinkObject

All Implemented Interfaces:

ErrorHandler, DomainObject

public class URLLinkObject
extends DomainObjectAdapterDB

URLLinkObject provides a link-file path/URL wrapper where the path/URL is intended to refer to a DomainFile within a local or remote project/repository. Link files which correspond to this type of DomainObject are not intended to be modified and should be created or deleted. A checkout may be used when an offline copy is required but otherwise serves no purpose since a modification and checkin is not supported.

NOTE: This exists for backward compatibility and is no longer used for storing newly created link-files.

Field Summary

Fields inherited from class ghidra.framework.data.DomainObjectAdapterDB

changeSet, dbh, NUM_UNDOS, options

Fields inherited from class ghidra.framework.data.DomainObjectAdapter

changed, changeSupportMap, DEFAULT_NAME, lock, metadata, name, temporary

Fields inherited from interface ghidra.framework.model.DomainObject

DO_DOMAIN_FILE_CHANGED, DO_OBJECT_CLOSED, DO_OBJECT_ERROR, DO_OBJECT_RENAMED, DO_OBJECT_RESTORED, DO_OBJECT_SAVED, DO_PROPERTY_CHANGED, undoLock

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns a word or short phrase that best describes or categorizes the object in terms that a user will understand.
String	getLinkPath()	Get the stored link path/URL
final boolean	isChangeable()	Returns true if changes are permitted.
final void	saveToPackedFile(File outputFile, TaskMonitor monitor)	Saves (i.e., serializes) the current content to a packed file.

Methods inherited from class ghidra.framework.data.DomainObjectAdapterDB

addSynchronizedDomainObject, addTransactionListener, canLock, canRedo, canSave, canUndo, clearCache, clearUndo, clearUndo, close, dbError, domainObjectRestored, endTransaction, flushWriteCache, forceLock, getAllRedoNames, getAllUndoNames, getChangeSet, getCurrentTransactionInfo, getDBHandle, getOptions, getOptionsNames, getRedoName, getSynchronizedDomainObjects, getUndoName, getUndoStackDepth, getUserData, hasTerminatedTransaction, invalidate, invalidateWriteCache, isChanged, isClosed, isLocked, loadMetadata, lock, openTransaction, performPropertyListAlterations, propertyChanged, redo, releaseSynchronizedDomainObject, removeTransactionListener, save, saveMetadata, setChanged, setImmutable, startTransaction, startTransaction, undo, unlock, updateMetadata

Methods inherited from class ghidra.framework.data.DomainObjectAdapter

addCloseListener, addConsumer, addDomainFileListener, addListener, checkExclusiveAccess, createPrivateEventQueue, fatalErrorOccurred, fireEvent, flushEvents, flushPrivateEventQueue, getAssociatedUserFilesystem, getChangeStatus, getConsumerList, getContentHandler, getContentHandler, getContentHandler, getContentHandlers, getDomainFile, getLock, getMetadata, getModificationNumber, getName, hasExclusiveAccess, isSendingEvents, isTemporary, isUsedBy, release, removeCloseListener, removeDomainFileListener, removeListener, removePrivateEventQueue, setDomainFile, setEventsEnabled, setName, setTemporary, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ghidra.framework.model.DomainObject

withTransaction, withTransaction

Method Details

getDescription

public String getDescription()

Description copied from interface: DomainObject

Returns a word or short phrase that best describes or categorizes the object in terms that a user will understand.

Specified by:

getDescription in interface DomainObject

Specified by:

getDescription in class DomainObjectAdapter

Returns:

the description

getLinkPath

public String getLinkPath()

Get the stored link path/URL

Returns:

link path/URL

isChangeable

public final boolean isChangeable()

Description copied from interface: DomainObject

Returns true if changes are permitted.

Returns:

true if changes are permitted.

saveToPackedFile

public final void saveToPackedFile(File outputFile,
 TaskMonitor monitor)
                            throws IOException,
CancelledException

Description copied from interface: DomainObject

Saves (i.e., serializes) the current content to a packed file.

Specified by:

saveToPackedFile in interface DomainObject

Overrides:

saveToPackedFile in class DomainObjectAdapterDB

Parameters:

outputFile - packed output file

monitor - progress monitor

Throws:

IOException - if an exception occurs

CancelledException - if the user cancels