borland Packages  Class Hierarchy  jbcl.model Package  Index 

StringFormatter component

java.lang.Object
   +----borland.jbcl.model.ItemFormatter
           +----borland.jbcl.model.VariantFormatter
                   +----borland.jbcl.model.StringFormatter

About the StringFormatter component

Constructors  Properties  Methods  

Implements Serializable

The StringFormatter class formats and parses string data.

StringFormatter uses the pattern property of ItemFormatter to access the edit/display mask patterns that are used to format and parse the data.

See also: Edit/display mask patterns


StringFormatter constructors

StringFormatter properties

*Read-only properties **Write-only properties

Properties implemented in this class

Properties implemented in borland.jbcl.model.VariantFormatter

Properties implemented in java.lang.Object

StringFormatter methods

Methods implemented in this class

Methods implemented in borland.jbcl.model.VariantFormatter

Methods implemented in java.lang.Object


StringFormatter constructors

StringFormatter()

  public StringFormatter()
Constructs a StringFormatter object.

StringFormatter properties

variantType

 public int getVariantType()
Returns the Variant type of StringFormatter, which is always Variant.STRING.

StringFormatter methods

format(borland.jbcl.util.Variant)

  public final String format(borland.jbcl.util.Variant value)
Returns a String representing the given value stored in the supplied object. All reasonable attempts are made to "cast" the type found in the object into the appropriate type specified in the constructor of the implementing classes. A returned empty string indicates a null or empty input value. null means the formatting failed.

Parameters:

value
The value to be formatted to a String.

Overrides: borland.jbcl.model.VariantFormatter.format(borland.jbcl.util.Variant)

parse(borland.jbcl.util.Variant, char[], int, int)

  public void parse(borland.jbcl.util.Variant variant, char[] value, int offset, int len)
A high-speed parse that parses directly into a character array.

Parameters:

variant
The parsed value (may not be null).
value
The character array containing the text to parse.
offset
The zero-based offset into the character array.
len
The maximum number of characters in the array to use in the parse.

Overrides: borland.jbcl.model.VariantFormatter.parse(borland.jbcl.util.Variant, char[], int, int)

parse(java.lang.String, borland.jbcl.util.Variant)

  public void parse(java.lang.String stringValue, borland.jbcl.util.Variant value)
Analyzes the given String and produces as output a Variant containing the approriate value.

Parameters:

stringValue
The string to be parsed.
value
The Variant that receives the parsed result.

Overrides: borland.jbcl.model.VariantFormatter.parse(java.lang.String, borland.jbcl.util.Variant)