oracle.ide.feedback

Class FeedbackLogOptions

java.lang.Object

oracle.ide.feedback.FeedbackLogOptions

public class FeedbackLogOptions
extends java.lang.Object

FeedbackManager log handler options for feedback logged through a Logger. If a FeedbackLogOptions instance is included in the parameters of a log message, the handling of the message by the FeedbackManager's log handler will use the options given in the instance.

Warning: This was created to feed the preexisting FeedbackManager API, which does not support arbitrary combinations (e.g., it does not support API depth and API name).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FeedbackLogOptions.Data

Constructor Summary

Constructors

Constructor and Description
FeedbackLogOptions() Creates an options instance with a null exception, API name, and API depth.
FeedbackLogOptions(java.lang.String dataDescription, java.lang.String dataText) Creates an options instance.
FeedbackLogOptions(java.lang.Throwable exception) Creates an options instance.
FeedbackLogOptions(java.lang.Throwable exception, int apiDepth) Creates an options instance.
FeedbackLogOptions(java.lang.Throwable exception, java.lang.String apiName) Creates an options instance.
FeedbackLogOptions(java.lang.Throwable exception, java.lang.String dataDescription, java.lang.String dataContent) Creates an options instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAdditionalData(java.lang.String description, java.lang.String content)
java.util.List<FeedbackLogOptions.Data>	getAdditionalData()
java.lang.Integer	getApiDepth() Gets the number of stack frames in the exception associated with this feedback message that are part of the reporting API and should not be considered when identifying bugs.
java.lang.String	getApiName() Gets the API name associated with this feedback message, or null if the handler should attempt to extract it from the message.
java.lang.Throwable	getException() Gets the exception associated with this feedback message, or null if the handler should use LogRecord.getThrown().
void	setApiDepth(java.lang.Integer apiDepth) Sets the number of stack frames in the exception associated with this feedback message that are part of the reporting API and should not be considered when identifying bugs.
void	setApiName(java.lang.String apiName) Sets the API name associated with this feedback message, or null if the handler should attempt to extract it from the message.
void	setException(java.lang.Throwable exception) Sets the exception associated with this feedback message, or null if the handler should use LogRecord.getThrown().

Methods inherited from class java.lang.Object

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

Constructor Detail

FeedbackLogOptions

public FeedbackLogOptions()

Creates an options instance with a null exception, API name, and API depth.

FeedbackLogOptions

public FeedbackLogOptions(java.lang.Throwable exception,
                  int apiDepth)

Creates an options instance.

FeedbackLogOptions

public FeedbackLogOptions(java.lang.Throwable exception,
                  java.lang.String apiName)

Creates an options instance.

FeedbackLogOptions

public FeedbackLogOptions(java.lang.Throwable exception)

Creates an options instance.

FeedbackLogOptions

public FeedbackLogOptions(java.lang.Throwable exception,
                  java.lang.String dataDescription,
                  java.lang.String dataContent)

Creates an options instance.

FeedbackLogOptions

public FeedbackLogOptions(java.lang.String dataDescription,
                  java.lang.String dataText)

Creates an options instance.

Method Detail

getException

public java.lang.Throwable getException()

Gets the exception associated with this feedback message, or null if the handler should use LogRecord.getThrown().

setException

public void setException(java.lang.Throwable exception)

Sets the exception associated with this feedback message, or null if the handler should use LogRecord.getThrown().

getApiDepth

public java.lang.Integer getApiDepth()

Gets the number of stack frames in the exception associated with this feedback message that are part of the reporting API and should not be considered when identifying bugs.

setApiDepth

public void setApiDepth(java.lang.Integer apiDepth)

Sets the number of stack frames in the exception associated with this feedback message that are part of the reporting API and should not be considered when identifying bugs.

getApiName

public java.lang.String getApiName()

Gets the API name associated with this feedback message, or null if the handler should attempt to extract it from the message.

setApiName

public void setApiName(java.lang.String apiName)

Sets the API name associated with this feedback message, or null if the handler should attempt to extract it from the message.

getAdditionalData

public java.util.List<FeedbackLogOptions.Data> getAdditionalData()

addAdditionalData

public void addAdditionalData(java.lang.String description,
                     java.lang.String content)