oracle.ide.externaltools

Class ExternalToolBaseProperties

java.lang.Object

oracle.javatools.data.HashStructureAdapter

oracle.ide.externaltools.ExternalToolBaseProperties

public final class ExternalToolBaseProperties
extends HashStructureAdapter

Base properties for an external tool.

Since:

11.1.1

Field Summary

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Method Summary

Methods

Modifier and Type	Method and Description
Availability	getAvailability() Get when this tool is available.
java.util.List<java.lang.String>	getAvailableTypes() Get the types this tool is available on.
java.lang.String	getCaption() Get the caption for this external tool.
java.net.URL	getIconURL() Get the URL of the icon for this external tool.
static ExternalToolBaseProperties	getInstance(ExternalTool tool)
static ExternalToolBaseProperties	getInstance(HashStructure hs) Gets an instance of ExternalToolBaseProperties for the specified hash structure.
boolean	getLogOutput()
boolean	getReloadBuffers() Get whether buffers will be reloaded after running this tool.
boolean	getSaveAllBeforeRun()
java.lang.String	getScannerTag() Get the scanner tag for this tool.
boolean	getShowInRunManager() Returns whether this tool will be shown in the run manager.
java.lang.String	getToolTipText() Get the tool tip text for this tool.
boolean	isIntegrated(IntegrationPoint ip) Returns true if this tool is integrated at the specified integration point.
void	setAvailability(Availability availability) Set when this tool is available.
void	setAvailableTypes(java.util.List<java.lang.String> types) Set the types this tool is available on.
void	setCaption(java.lang.String caption) Set the caption for this external tool.
void	setIconURL(java.net.URL url) Set the URL of the icon for this external tool.
void	setIntegrated(IntegrationPoint ip, boolean integrated) Sets whether this tool is integrated at a specific integration point.
void	setLogOutput(boolean logOutput)
void	setReloadBuffers(boolean reload) Set whether to reload buffers after running this tool
void	setSaveAllBeforeRun(boolean saveAllBeforeRun)
void	setScannerTag(java.lang.String tag) An ExternalToolScanner that creates a tool can set a tag on the tool so that it can identify whether the tool has been created in future.
void	setShowInRunManager(boolean showInRunManager) Sets whether this tool will be shown in the run manager.
void	setToolTipText(java.lang.String toolTipText) Set the tool tip text for this tool.

Methods inherited from class oracle.javatools.data.HashStructureAdapter

addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ExternalToolBaseProperties getInstance(HashStructure hs)

Gets an instance of ExternalToolBaseProperties for the specified hash structure.

Parameters:

hs - a hash structure.

Returns:

an instance of ExternalToolBaseProperties

Throws:

java.lang.NullPointerException - if hs is null.

getInstance

public static ExternalToolBaseProperties getInstance(ExternalTool tool)

setShowInRunManager

public void setShowInRunManager(boolean showInRunManager)

Sets whether this tool will be shown in the run manager. If true, the tool will be available in the Run Manager dockable window, and can be terminated using Run->Terminate.

Parameters:

showInRunManager - if true, show this tool in the run manager.

Since:

11.1.1.0.1

getShowInRunManager

public boolean getShowInRunManager()

Returns whether this tool will be shown in the run manager.

Returns:

true if this tool is shown in the run manager.

Since:

11.1.1.0.1

setScannerTag

public void setScannerTag(java.lang.String tag)

An ExternalToolScanner that creates a tool can set a tag on the tool so that it can identify whether the tool has been created in future.

Parameters:

tag - a tag recognized by the scanner that created a tool

getScannerTag

public java.lang.String getScannerTag()

Get the scanner tag for this tool.

Returns:

the scanner tag for this tool.

setReloadBuffers

public void setReloadBuffers(boolean reload)

Set whether to reload buffers after running this tool

Parameters:

reload - if true, the tool will force a buffer reload

getReloadBuffers

public boolean getReloadBuffers()

Get whether buffers will be reloaded after running this tool. Subclasses are responsible for ensuring that this request is honored after running the tool.

Returns:

true if the IDE's buffers are reloaded after running.

setLogOutput

public void setLogOutput(boolean logOutput)

getLogOutput

public boolean getLogOutput()

setSaveAllBeforeRun

public void setSaveAllBeforeRun(boolean saveAllBeforeRun)

getSaveAllBeforeRun

public boolean getSaveAllBeforeRun()

getAvailableTypes

public java.util.List<java.lang.String> getAvailableTypes()

Get the types this tool is available on. This is used if the availability is Availability.SELECTED_TYPES.

Returns:

a list of class names, which should match class names in oracle.ide.config.DocumentExtensions.DocRecord.getDocClass(). The returned collection is not modifiable.

setAvailableTypes

public void setAvailableTypes(java.util.List<java.lang.String> types)

Set the types this tool is available on. This is used if the availability is Availability.SELECTED_TYPES.

Parameters:

types - a list of class names, which should match class names in oracle.ide.config.DocumentExtensions.DocRecord.getDocClass().

getIconURL

public java.net.URL getIconURL()

Get the URL of the icon for this external tool.

Returns:

a URL pointing to an icon file to use for this tool. If null, no icon will be used.

setIconURL

public void setIconURL(java.net.URL url)

Set the URL of the icon for this external tool.

Parameters:

url - a URL pointing to an icon file to use for this tool. If null, no icon will be used.

getCaption

public java.lang.String getCaption()

Get the caption for this external tool. If the caption contains an ampersand character, the subsequent character will be used as the mnemonic when this tool is displayed in menus.

Returns:

a String caption for the tool. Must not be null.

setCaption

public void setCaption(java.lang.String caption)

Set the caption for this external tool. If the caption contains an ampersand character, the subsequent character will be used as the mnemonic when this tool is displayed in menus.

Parameters:

caption - a String caption for the tool. Must not be null.

getToolTipText

public java.lang.String getToolTipText()

Get the tool tip text for this tool.

Returns:

a String to be used as tool tip text for the tool. May be null.

setToolTipText

public void setToolTipText(java.lang.String toolTipText)

Set the tool tip text for this tool.

Parameters:

toolTipText - a String to be used as tool tip text for the tool. May be null.

isIntegrated

public boolean isIntegrated(IntegrationPoint ip)

Returns true if this tool is integrated at the specified integration point.

Parameters:

ip - an integration point.

Returns:

true if this tool is integrated at the specified point, false otherwise.

Throws:

java.lang.NullPointerException - if ip is null.

setIntegrated

public void setIntegrated(IntegrationPoint ip,
                 boolean integrated)

Sets whether this tool is integrated at a specific integration point.

Parameters:

ip - an integration point.

integrated - true if this tool is integrated at the specified point, false otherwise.

Throws:

java.lang.NullPointerException - if ip is null.

getAvailability

public Availability getAvailability()

Get when this tool is available.

Returns:

an Availability enum value.

setAvailability

public void setAvailability(Availability availability)

Set when this tool is available.

Parameters:

availability - an Availability enum value.