2.3.5 - String Writer Interface - JdlStringWriter

John W. Campbell

2.3.5.1 Introduction

This is an interface written originally for use with the JdlKeywordDataModule object (package Jdl.JdlKDM). It is used by objects to output data from a String which may be split into words. The method is expected to split the string, at word boundaries, to fit into a requested width.

Definition and methods:

Class Details
Accessible Fields
Methods

2.3.5.2 Class Details

Package:
Jdl.JdlLib;
Class name:
JdlStringWriter
Class definition:
public interface JdlStringWriter
Extends:
Object
Implements:
none
Actions:
none

2.3.5.3 Accessible Fields

No fields with public, package or protected access defined.

2.3.5.4 Methods

2.3.5.4.1 Introduction

This interface has a single method to write out a string.

Method:

Write the string - writeString

2.3.5.4.2 Write the string - writeString

A method to print or output a string of words/items. The method is expected to split the output strings (at word boundaries) to fit within the required width. Note that any output exceptions, which may occur, must be caught by the method.

Method Definition:
public void writeString(String str, int width, JdlError err)
Parameters List:
str
The string to be output.
width
The maximum width (number of characters) for an output line.
err
If an error is found then 'err.err' must be set to true and 'err.flag' must be set to -10. The error object should be cleared using 'err.clear()' at the start of the method.
⇑ Up 2   ⇑ Up 1   ⇑ Top of this