xbn.string.padchop
Class SpcfcCfgChop

java.lang.Object
  |
  +--xbn.XBNObject
        |
        +--xbn.string.padchop.SpcfcCfgChop

public class SpcfcCfgChop

extends XBNObject

Part of PCSConfig that configures chop-specific items. See PCSConfig.

Source code: SpcfcCfgChop.java

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

SpcfcCfgChop()
Create a SpcfcCfgChop with default settings.

SpcfcCfgChop(boolean b_chopEndStart)
Create a SpcfcCfgChop.

SpcfcCfgChop(boolean b_chopEndStart, String s_chopDotDotDot)
Create a SpcfcCfgChop.

SpcfcCfgChop(boolean b_chopEndStart, String s_chopDotDotDot, int i_cdddFlush)
Create a SpcfcCfgChop.

SpcfcCfgChop(String s_chopDotDotDot)
Create a SpcfcCfgChop.

Method Summary

int	getCDDDFlush() Get the chop ellipsis flush setting.
String	getChopDotDotDot() When chopping should there be an ellipsis, indicating that the text was, in fact, chopped?.
boolean	getChopSideEndStart() When the string needs to be chopped, which end should it happen to?
String	toString() Get some information about this SpcfcCfgChop.

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, wait, wait, wait

Constructor Detail

SpcfcCfgChop

public SpcfcCfgChop()

Create a SpcfcCfgChop with default settings.

Equal to SpcfcCfgChop(true)

SpcfcCfgChop

public SpcfcCfgChop(boolean b_chopEndStart)

Create a SpcfcCfgChop.

Equal to SpcfcCfgChop(b_chopEndStart, null)

SpcfcCfgChop

public SpcfcCfgChop(String s_chopDotDotDot)

Create a SpcfcCfgChop.

Equal to SpcfcCfgChop(true, s_chopDotDotDot)

SpcfcCfgChop

public SpcfcCfgChop(boolean b_chopEndStart,
                    String s_chopDotDotDot)

Create a SpcfcCfgChop.

Equal to SpcfcCfgChop(b_chopEndStart, s_chopDotDotDot, 0)

SpcfcCfgChop

public SpcfcCfgChop(boolean b_chopEndStart,
                    String s_chopDotDotDot,
                    int i_cdddFlush)

Create a SpcfcCfgChop.

Parameters:

b_chopEndStart - When the string needs to be chopped, which end should it happen to? See getChopSideEndStart.

s_chopDotDotDot - The chop ellipsis text. If non-null, must be at least one character in length. If null, no ellipsis is used (i_cdddFlush is ignored). See getChopDotDotDot. Note that the chop ellipsis is only used when the text is actually chopped, regardless the value of i_cdddFlush.

i_cdddFlush - The number of ellipsis characters that should be "sticking out" of the chopped text. Must be between zero and [length of s_chopDotDotDot] inclusive, where zero is perfectly flushed (completely contained in the chopped string text) and [length of s_chopDotDotDot] is concatenated to the chopped string. If s_chopDotDotDot is null, this parameter is ignored. See getCDDDFlush.

Method Detail

getChopSideEndStart

public final boolean getChopSideEndStart()

When the string needs to be chopped, which end should it happen to?

Returns:

b_chopEndStart exactly as provided to the constructor.

getChopDotDotDot

public final String getChopDotDotDot()

When chopping should there be an ellipsis, indicating that the text was, in fact, chopped?. See getCDDDFlush.

Returns:

s_chopDotDotDot exactly as provided to the constructor.

getCDDDFlush

public final int getCDDDFlush()

Get the chop ellipsis flush setting. See getChopDotDotDot.

Returns:

i_cdddFlush exactly as provided to the constructor.

toString

public String toString()

Get some information about this SpcfcCfgChop.

Overrides:

toString in class Object