C E F G I L O P R S T

C

com.lightyosft.logmx.gotosource - package com.lightyosft.logmx.gotosource

com.lightyosft.logmx.gotosource.business - package com.lightyosft.logmx.gotosource.business

com.lightyosft.logmx.gotosource.network - package com.lightyosft.logmx.gotosource.network

com.lightyosft.logmx.gotosource.util - package com.lightyosft.logmx.gotosource.util

E

equals(Object) - Method in class com.lightyosft.logmx.gotosource.business.PluginConfig

error(String) - Method in interface com.lightyosft.logmx.gotosource.util.PluginLogger

Log an error message

error(String, Throwable) - Method in interface com.lightyosft.logmx.gotosource.util.PluginLogger

Log an error message and an associated throwable

F

fromString(String) - Static method in class com.lightyosft.logmx.gotosource.business.SourcePreview

Creates a SourcePreview from a string.
The given string must match the pattern

G

getClazz() - Method in class com.lightyosft.logmx.gotosource.business.SourceLocation

Getter for the Class name (named this way because of Java reserved word 'class')

getFileName() - Method in class com.lightyosft.logmx.gotosource.business.SourceLocation

Getter for the Source file name

getFullyQualifiedClass() - Method in class com.lightyosft.logmx.gotosource.business.SourceLocation

Getter for the fully qualified Class name (i.e.

getFullyQualifiedMethod() - Method in class com.lightyosft.logmx.gotosource.business.SourceLocation

Getter for the fully qualified method name (i.e.

getHostName() - Method in class com.lightyosft.logmx.gotosource.business.PluginConfig

Getter for attribute PluginConfig.hostName

getInstance(GotoSourceManager, PluginLogger) - Static method in class com.lightyosft.logmx.gotosource.network.SocketListener

Return the single instance of a SocketListener

getLineNumber() - Method in class com.lightyosft.logmx.gotosource.business.SourceLocation

Getter for the line number inside source file name

getMethod() - Method in class com.lightyosft.logmx.gotosource.business.SourceLocation

Getter for the Method name

getPackageName() - Method in class com.lightyosft.logmx.gotosource.business.SourceLocation

Getter for the fully qualified Package name

getPort() - Method in class com.lightyosft.logmx.gotosource.business.PluginConfig

Getter for attribute PluginConfig.port

goToSourceLocation(SourceLocation) - Method in interface com.lightyosft.logmx.gotosource.GotoSourceManager

Open and highlight the given source location in the IDE

GotoSourceManager - Interface in com.lightyosft.logmx.gotosource

Features that the IDE plug-in must implement

GotoSourceUtils - Class in com.lightyosft.logmx.gotosource

Utility class that can be used by IDE plug-ins

GotoSourceUtils() - Constructor for class com.lightyosft.logmx.gotosource.GotoSourceUtils

I

info(String) - Method in interface com.lightyosft.logmx.gotosource.util.PluginLogger

Log an information message

isEnabled() - Method in class com.lightyosft.logmx.gotosource.business.PluginConfig

Getter for attribute PluginConfig.enabled

L

lineToHighlight - Variable in class com.lightyosft.logmx.gotosource.business.SourcePreview

Index of the line to highlight in LogMX, or -1 if unknown (first line is 1)

O

ok - Variable in class com.lightyosft.logmx.gotosource.business.SourcePreview

Flag indicating if the source code is available in this object (false if the source code couldn't be retrieved)

P

PluginConfig - Class in com.lightyosft.logmx.gotosource.business

Holder for the plug-in configuration parameters

PluginConfig(String, int, boolean) - Constructor for class com.lightyosft.logmx.gotosource.business.PluginConfig

Create a PluginConfig with the given host name, port, and enable flag

PluginConfig(PluginConfig) - Constructor for class com.lightyosft.logmx.gotosource.business.PluginConfig

Copy-constructor (clone the given config)

PluginConfig() - Constructor for class com.lightyosft.logmx.gotosource.business.PluginConfig

Empty default constructor

PluginLogger - Interface in com.lightyosft.logmx.gotosource.util

Interface for a logger that logs events into IDE logs

PREVIEW_LINES_RANGE - Static variable in class com.lightyosft.logmx.gotosource.business.SourcePreview

Number of lines that should be displayed before and after the line to highlight (PREVIEW_LINES_RANGE lines before and PREVIEW_LINES_RANGE lines after)

previewFile(InputStream, int) - Static method in class com.lightyosft.logmx.gotosource.GotoSourceUtils

Read the given stream and use it to return a valid SourcePreview for the given line number

previewSourceLocation(SourceLocation) - Method in interface com.lightyosft.logmx.gotosource.GotoSourceManager

Return the given source location text.
This method can use the helper method GotoSourceUtils.previewFile(java.io.InputStream, int) as a convenience if needed

R

REQUEST_CMD_GOTO - Static variable in class com.lightyosft.logmx.gotosource.network.SocketListener

Request command to go to a source code

REQUEST_CMD_PREVIEW - Static variable in class com.lightyosft.logmx.gotosource.network.SocketListener

Request command to preview a source code

REQUEST_CMD_TEST - Static variable in class com.lightyosft.logmx.gotosource.network.SocketListener

Request command to test IDE plug-in

RESPONSE_OK - Static variable in class com.lightyosft.logmx.gotosource.network.SocketListener

Value returned by the 'test' command in case of success

S

setConfig(PluginConfig) - Method in class com.lightyosft.logmx.gotosource.network.SocketListener

Set the settings to use by this Listener

setEnabled(boolean) - Method in class com.lightyosft.logmx.gotosource.business.PluginConfig

Setter for attribute PluginConfig.enabled

setFullyQualifiedClass(String) - Method in class com.lightyosft.logmx.gotosource.business.SourceLocation

Setter for the fully qualified Class name (i.e.

setHostName(String) - Method in class com.lightyosft.logmx.gotosource.business.PluginConfig

Setter for attribute PluginConfig.hostName

setMethod(String) - Method in class com.lightyosft.logmx.gotosource.business.SourceLocation

Setter for the Method name

setPort(int) - Method in class com.lightyosft.logmx.gotosource.business.PluginConfig

Setter for attribute PluginConfig.port

SocketListener - Class in com.lightyosft.logmx.gotosource.network

Listener that will process requests (test, preview, goto) received from LogMX

SourceLocation - Class in com.lightyosft.logmx.gotosource.business

Describes a source location

SourceLocation(String, String, int) - Constructor for class com.lightyosft.logmx.gotosource.business.SourceLocation

Create a Source Location

SourcePreview - Class in com.lightyosft.logmx.gotosource.business

Preview of a source code (excerpt), optionally with a highlighted line

SourcePreview() - Constructor for class com.lightyosft.logmx.gotosource.business.SourcePreview

Empty default constructor

SourcePreview(boolean, String, int) - Constructor for class com.lightyosft.logmx.gotosource.business.SourcePreview

Create a SourcePreview with a value for each of its attributes

start() - Method in class com.lightyosft.logmx.gotosource.network.SocketListener

Start listening to LogMX requests (test, preview, goto).
This method creates a new thread in order to open a socket, and listens this socket.

stop() - Method in class com.lightyosft.logmx.gotosource.network.SocketListener

Stop listening to LogMX requests (test, preview, goto).
This method closes the socket, and stops the thread.

T

text - Variable in class com.lightyosft.logmx.gotosource.business.SourcePreview

Lines of source code, or error message if attribute ok is false

toString() - Method in class com.lightyosft.logmx.gotosource.business.PluginConfig

toString() - Method in class com.lightyosft.logmx.gotosource.business.SourceLocation

Returns a string representation of the object, formated as:
SourceLocation.fullyQualifiedMethod(SourceLocation.fileName:SourceLocation.lineNumber)

toString() - Method in class com.lightyosft.logmx.gotosource.business.SourcePreview

toUserString() - Method in class com.lightyosft.logmx.gotosource.business.SourceLocation

Returns a string representation of the object, that can be displayed to the user.

C E F G I L O P R S T