MessageEmit (bw-util-servlet 4.1.0 API)

All Superinterfaces:

org.bedework.util.logging.Logged, Serializable
```
public interface MessageEmit
extends Serializable, org.bedework.util.logging.Logged
```
This object allows context free error message generation. At the point messages are generated we might be called from the web world or from an application world.
Each method takes a property name as the first parameter. Optional arguments follow.
The implementation is of course free to interpret the first parameter any way it wants. The assumption though, is that rather than providing the actual message text the pname acts as a reference.

Version:

1.0

Author:

Mike Douglass douglm@rpi.edu

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`clear()`	Indicate no messages emitted.
`void`	`emit(String pname)`	Emit message with given property name
`void`	`emit(String pname, int num)`	Emit message with given property name and int value
`void`	`emit(String pname, Object o)`	Emit message with given property name and Object value
`void`	`emit(String pname, Object o1, Object o2)`	Emit message with given property name and Object values
`void`	`emit(String pname, Object o1, Object o2, Object o3)`	Emit message with given property name and Object values
`void`	`emit(Throwable t)`	Emit an exception message
`boolean`	`messagesEmitted()`
`void`	`setExceptionPname(String pname)`	Set the property name of the default exception message

Methods inherited from interface org.bedework.util.logging.Logged
audit, debug, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, error, getLogger, getLogLevel, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsDebugEnabled, isMetricsLoggerEnabled, metrics, setLoggerClass, setLoggerClass, setLogLevel, trace, trace, warn

- Method Detail
  - emit
```
void emit(String pname)
```
    Emit message with given property name
    
    Parameters:
    
    pname -
  - emit
```
void emit(String pname,
          int num)
```
    Emit message with given property name and int value
    
    Parameters:
    
    pname -
    
    num -
  - setExceptionPname
```
void setExceptionPname(String pname)
```
    Set the property name of the default exception message
    
    Parameters:
    
    pname -
  - emit
```
void emit(Throwable t)
```
    Emit an exception message
    
    Parameters:
    
    t -
  - emit
```
void emit(String pname,
          Object o)
```
    Emit message with given property name and Object value
    
    Parameters:
    
    pname -
    
    o -
  - emit
```
void emit(String pname,
          Object o1,
          Object o2)
```
    Emit message with given property name and Object values
    
    Parameters:
    
    pname -
    
    o1 -
    
    o2 -
  - emit
```
void emit(String pname,
          Object o1,
          Object o2,
          Object o3)
```
    Emit message with given property name and Object values
    
    Parameters:
    
    pname -
    
    o1 -
    
    o2 -
    
    o3 -
  - clear
```
void clear()
```
    Indicate no messages emitted.
  - messagesEmitted
```
boolean messagesEmitted()
```
    Returns:
    
    true if any messages emitted