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

DomainObjectAdapterLink object provides a Ghidra URL (see GhidraURL) wrapper where the URL is intended to refer to a DomainFile within another 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.

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

Constructor Summary

Constructors

Constructor	Description
URLLinkObject(DBHandle dbh, Object consumer)	Constructs a link file object from a DBHandle (read-only)
URLLinkObject(String name, URL ghidraUrl, Object consumer)	Constructs a new link file object

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.
URL	getLink()	Get link 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, 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

Constructor Details

URLLinkObject

public URLLinkObject(String name,
 URL ghidraUrl,
 Object consumer)
              throws IOException

Constructs a new link file object

Parameters:

name - link name

ghidraUrl - link URL

consumer - the object that is using this program.

Throws:

IOException - if there is an error accessing the database or invalid URL specified.

URLLinkObject

public URLLinkObject(DBHandle dbh,
 Object consumer)
              throws IOException

Constructs a link file object from a DBHandle (read-only)

Parameters:

dbh - a handle to an open program database.

consumer - the object that keeping the program open.

Throws:

IOException - if an error accessing the database occurs.

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

getLink

public URL getLink()

Get link URL

Returns:

link 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