xbn.output
Class UtilOutput

java.lang.Object
  |
  +--xbn.XBNObject
        |
        +--xbn.output.UtilOutput

public class UtilOutput

extends XBNObject

Random functions relating to xbn.output.

Source code: UtilOutput.java.

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

UtilOutput()
Create a UtilOutput.

Method Summary

Outputter	getOptrFromOW(OWriter o_writer) Create an Outputter containing the provided OWriter.
Outputter	getOptrFromOW(OWriter o_writer, MsgFormat msg_format, String s_owriterName, String s_callingClsFnc) Create an Outputter containing the provided OWriter.
Outputter	getOptrFromOW(OWriter o_writer, String s_owriterName, String s_callingClsFnc) Create an Outputter containing the provided OWriter.
void	throwAXOrDebug(String s_error, Outputter optr_dbg) Either throw an AssertException or just debug the error message.

Methods inherited from class xbn.XBNObject

getXMsgPrefix, sop, sopl, sopl, throwAX, throwAXIfBadStr, throwAXIfNull, throwAXSpoof

Methods inherited from class java.lang.Object

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

Constructor Detail

UtilOutput

public UtilOutput()

Create a UtilOutput. This constructor does nothing.

Method Detail

getOptrFromOW

public final Outputter getOptrFromOW(OWriter o_writer)

Create an Outputter containing the provided OWriter.

Returns:

getOptrFromOW(o_writer, "o_writer", "xbn.output.UtilOutput.getOptrFromOW")

getOptrFromOW

public final Outputter getOptrFromOW(OWriter o_writer,
                                     String s_owriterName,
                                     String s_callingClsFnc)

Create an Outputter containing the provided OWriter.

Returns:

getOptrFromOW(o_writer, (new MFPlain()), s_owriterName, s_callingClsFnc)

getOptrFromOW

public final Outputter getOptrFromOW(OWriter o_writer,
                                     MsgFormat msg_format,
                                     String s_owriterName,
                                     String s_callingClsFnc)

Create an Outputter containing the provided OWriter.

Parameters:

o_writer - The OWriter the returned Outputter should contain. May not be null.

msg_format - The MsgFormat object the returned Outputter should contain. May not be null.

s_owriterName - The descriptive name of o_writer, for the sake of potential error messages only.

s_callingClsFnc - The class-name-dot-function that this function is being called from, for the sake of potential error messages only.

Returns:

(new Outputter(o_writer, (new OConfig(msg_format, true))))

throwAXOrDebug

public final void throwAXOrDebug(String s_error,
                                 Outputter optr_dbg)

Either throw an AssertException or just debug the error message.

Parameters:

s_error - The error message. May not be null, or zero characters in length.

optr_dbg - The Outputter to (potentially) output s_error with. May not be null. If this is on the s_error is output, and no exception is thrown. Otherwise, an AssertException is thrown.