xbn.array.primitive
Class PARString

java.lang.Object
  |
  +--xbn.XBNObject
        |
        +--xbn.array.primitive.PrimitiveArrayRule
              |
              +--xbn.array.primitive.PARString

Direct Known Subclasses:

PARSGoodUnq

public class PARString

extends PrimitiveArrayRule

Defines the rules to be enforced by PrimitiveArrayString.isValid. See PrimitiveArrayString.isValid.

Source code: PARString.java.

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

PARString()
Create a completely unrestricted PARString.

PARString(PARDupNullLen par_dupNullLen)
Create a PARString.

PARString(PARDupNullLen par_dupNullLen, PAROrderDir par_orderDir)
Create a PARString.

PARString(PARDupNullLen par_dupNullLen, PAROrderDir par_orderDir, PARSContain pars_contain)
Create a PARString.

PARString(PARDupNullLen par_dupNullLen, PAROrderDir par_orderDir, PARSContain pars_contain, PARSElement pars_element)
Create an PARString.

PARString(PARDupNullLen par_dupNullLen, PAROrderDir par_orderDir, PARSElement pars_element)
Create a PARString.

PARString(PARDupNullLen par_dupNullLen, PARSContain pars_contain)
Create a PARString.

PARString(PARDupNullLen par_dupNullLen, PARSContain pars_contain, PARSElement pars_element)
Create a PARString.

PARString(PARDupNullLen par_dupNullLen, PARSElement pars_element)
Create a PARString.

PARString(PAROrderDir par_orderDir)
Create a PARString.

PARString(PAROrderDir par_orderDir, PARSElement pars_element)
Create a PARString.

PARString(PARSContain pars_contain)
Create a PARString.

PARString(PARSContain pars_contain, PARSElement pars_element)
Create a PARString.

PARString(PARSElement pars_element)
Create a PARString.

PARString(PARString par_string)
Create a full (deep) copy of the provided PARString.

Method Summary

PARSContain	getPARSContain() Get the PARSContain for direct manipulation.
PARSElement	getPARSElement() Get the PARSElement for direct manipulation.
boolean	isRestricted() Does this PARString have any restrictions?
String	toString() Get some information about this PARString.

Methods inherited from class xbn.array.primitive.PrimitiveArrayRule

getPARDupNullLen, getPAROrderDir

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

PARString

public PARString()

Create a completely unrestricted PARString.

Equal to PARString(new PARDupNullLen())

Note: Using this constructor causes isRestricted to equal true.

PARString

public PARString(PARDupNullLen par_dupNullLen)

Create a PARString.

Equal to PARString(par_dupNullLen, (new PAROrderDir()))

PARString

public PARString(PAROrderDir par_orderDir)

Create a PARString.

Equal to PARString((new PARDupNullLen()), par_orderDir)

PARString

public PARString(PARSContain pars_contain)

Create a PARString.

Equal to PARString((new PARDupNullLen()), pars_contain)

PARString

public PARString(PARSElement pars_element)

Create a PARString.

Equal to PARString((new PARDupNullLen()), pars_element)

PARString

public PARString(PARDupNullLen par_dupNullLen,
                 PAROrderDir par_orderDir)

Create a PARString.

Equal to PARString(par_dupNullLen, par_orderDir, (new PARSElement()))

PARString

public PARString(PARDupNullLen par_dupNullLen,
                 PARSContain pars_contain)

Create a PARString.

Equal to PARString(par_dupNullLen, pars_contain, (new PARSElement()))

PARString

public PARString(PARDupNullLen par_dupNullLen,
                 PARSElement pars_element)

Create a PARString.

Equal to PARString(par_dupNullLen, (new PAROrderDir()), pars_element)

PARString

public PARString(PAROrderDir par_orderDir,
                 PARSElement pars_element)

Create a PARString.

Equal to PARString((new PARDupNullLen()), par_orderDir, pars_element)

PARString

public PARString(PARSContain pars_contain,
                 PARSElement pars_element)

Create a PARString.

Equal to PARString((new PARDupNullLen()), pars_contain, pars_element)

PARString

public PARString(PARDupNullLen par_dupNullLen,
                 PAROrderDir par_orderDir,
                 PARSContain pars_contain)

Create a PARString.

Equal to PARString(par_dupNullLen, par_orderDir, pars_contain, (new PARSElement()))

PARString

public PARString(PARDupNullLen par_dupNullLen,
                 PAROrderDir par_orderDir,
                 PARSElement pars_element)

Create a PARString.

Equal to PARString(par_dupNullLen, par_orderDir, (new PARSContain()), pars_element)

PARString

public PARString(PARDupNullLen par_dupNullLen,
                 PARSContain pars_contain,
                 PARSElement pars_element)

Create a PARString.

Equal to PARString(par_dupNullLen, (new PAROrderDir()), pars_contain, pars_element)

PARString

public PARString(PARDupNullLen par_dupNullLen,
                 PAROrderDir par_orderDir,
                 PARSContain pars_contain,
                 PARSElement pars_element)

Create an PARString.

The first line of this constructor calls PrimitiveArrayRule(par_dupNullLen, par_orderDir).

Parameters:

pars_element - Defines element-specific rules. May not be null.

PARString

public PARString(PARString par_string)

Create a full (deep) copy of the provided PARString.

The first line of this constructor calls PrimitiveArrayRule(par_string)

Method Detail

getPARSContain

public final PARSContain getPARSContain()

Get the PARSContain for direct manipulation.

Returns:

pars_contain Exactly as provided to the constructor.

getPARSElement

public final PARSElement getPARSElement()

Get the PARSElement for direct manipulation.

Returns:

pars_element Exactly as provided to the constructor.

isRestricted

public boolean isRestricted()

Does this PARString have any restrictions?

Overrides:

isRestricted in class PrimitiveArrayRule

Returns:

(super.isRestricted() ||
getPARSContain().isRestricted() ||
getPARSElement().isRestricted())

toString

public String toString()

Get some information about this PARString.

Overrides:

toString in class PrimitiveArrayRule