2.17.2: 2011-06-17

net.sf.basedb.util
Class ContextUtil.ContextResult

java.lang.Object
  extended by net.sf.basedb.util.ContextUtil.ContextResult
Enclosing class:
ContextUtil

public static class ContextUtil.ContextResult
extends Object

Class for holding the result of a call to the InteractivePlugin.isInContext(GuiContext, Object) method.


Field Summary
private  PluginConfiguration config
           
private  String contextMessage
           
private  PluginDefinition plugin
           
private  Throwable throwable
           
 
Constructor Summary
  ContextUtil.ContextResult(PluginDefinition plugin, PluginConfiguration config, String contextMessage)
          Create a new warning-level result object.
  ContextUtil.ContextResult(PluginDefinition plugin, PluginConfiguration config, Throwable t)
          Create a new error-level result object.
private ContextUtil.ContextResult(SessionControl sc, PluginDefinition plugin, PluginConfiguration config, GuiContext context, Object currentItem)
           
 
Method Summary
 String getContextMessage()
          Get the warning level message, or the message from Throwable.getMessage() if this is an error-level object.
 Throwable getError()
          Get the exception that caused the error, or null if this is a warning-level object.
 String getName()
          Get the name of the plug-in configuration or, if the configuration is null, of the plug-in definition
 PluginConfiguration getPluginConfiguration()
          Get the plugin configuration that was checked, or null.
 PluginDefinition getPluginDefinition()
          Get the plugin definition that was checked.
 boolean isError()
          If this is an error-level object.
 boolean isInContext()
          If the context check was successful and generate no warnings or error.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

plugin

private final PluginDefinition plugin

config

private final PluginConfiguration config

contextMessage

private String contextMessage

throwable

private Throwable throwable
Constructor Detail

ContextUtil.ContextResult

private ContextUtil.ContextResult(SessionControl sc,
                                  PluginDefinition plugin,
                                  PluginConfiguration config,
                                  GuiContext context,
                                  Object currentItem)

ContextUtil.ContextResult

public ContextUtil.ContextResult(PluginDefinition plugin,
                                 PluginConfiguration config,
                                 String contextMessage)
Create a new warning-level result object.

Parameters:
plugin - The plugin definition
config - The plugin configuration or null
contextMessage - The warning message, or null if there is no warning or error

ContextUtil.ContextResult

public ContextUtil.ContextResult(PluginDefinition plugin,
                                 PluginConfiguration config,
                                 Throwable t)
Create a new error-level result object.

Parameters:
plugin - The plugin definition
config - The plugin configuration or null
t - The exception that caused the error
Method Detail

getPluginDefinition

public PluginDefinition getPluginDefinition()
Get the plugin definition that was checked.


getPluginConfiguration

public PluginConfiguration getPluginConfiguration()
Get the plugin configuration that was checked, or null.


getContextMessage

public String getContextMessage()
Get the warning level message, or the message from Throwable.getMessage() if this is an error-level object.


getError

public Throwable getError()
Get the exception that caused the error, or null if this is a warning-level object.


getName

public String getName()
Get the name of the plug-in configuration or, if the configuration is null, of the plug-in definition


isInContext

public boolean isInContext()
If the context check was successful and generate no warnings or error.


isError

public boolean isError()
If this is an error-level object.


2.17.2: 2011-06-17