xbn.string.padchop
Class SpcfcCfgPad

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

public class SpcfcCfgPad

extends XBNObject

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

Source code: SpcfcCfgPad.java

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

SpcfcCfgPad()
Create a SpcfcCfgPad with default settings.

SpcfcCfgPad(boolean b_padEndStart)
Create a SpcfcCfgPad.

SpcfcCfgPad(boolean b_padEndStart, char c_padCharacter)
Create a SpcfcCfgPad.

SpcfcCfgPad(char c_padCharacter)
Create a SpcfcCfgPad.

Method Summary

char	getPadChar() When the string should be padded, which character should it be padded with?
boolean	getPadSideEndStart() When the string needs to be padded, which end should it happen to?
String	toString() Get some information about this SpcfcCfgPad.

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

SpcfcCfgPad

public SpcfcCfgPad()

Create a SpcfcCfgPad with default settings.

Equal to SpcfcCfgPad(true)

SpcfcCfgPad

public SpcfcCfgPad(boolean b_padEndStart)

Create a SpcfcCfgPad.

Equal to SpcfcCfgPad(b_padEndStart, ' ')

SpcfcCfgPad

public SpcfcCfgPad(char c_padCharacter)

Create a SpcfcCfgPad.

Equal to SpcfcCfgPad(true, c_padCharacter)

SpcfcCfgPad

public SpcfcCfgPad(boolean b_padEndStart,
                   char c_padCharacter)

Create a SpcfcCfgPad.

Parameters:

b_padEndStart - When the string needs to be padded, which end should it happen to? If true, then pad the end (right) of the string. If false, the start (left). See getPadSideEndStart.

c_padCharacter - When the string is padded, which character should it be padded with? See getPadChar.

Method Detail

getPadSideEndStart

public final boolean getPadSideEndStart()

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

Returns:

b_padEndStart exactly as provided to the the constructor.

getPadChar

public final char getPadChar()

When the string should be padded, which character should it be padded with?

Returns:

c_padCharacter exactly as provided to the constructor.

toString

public String toString()

Get some information about this SpcfcCfgPad.

Overrides:

toString in class Object