com.goldencode.p2j.util

Class NullField

java.lang.Object

com.goldencode.p2j.util.FieldEntry

com.goldencode.p2j.util.NullField

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

SkipField, SpaceField

public class NullField
extends FieldEntry

Outputs null characters to a stream.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	explicit Contains an explicit column position.
private short	num An explicit column position.

Constructor Summary

Constructors

Constructor and Description
NullField() Default constructor (outputs a single space).
NullField(long num) Constructor for an explicit number of null characters.

Method Summary

Modifier and Type	Method and Description
(package private) int	getNum() Get explicit count.
(package private) boolean	isExplicit() Get current value of explicit flag.
void	output(Stream out) Renders the contained field definition to the given stream.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
void	resolveData() Notify instance that it is about to be transferred so all resolvable data should be resolved and prepared for sending via network.
protected void	setExplicit(boolean explicit) Set value of explicit flag.
protected void	setNum(long num) Set explicit count.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.

Methods inherited from class com.goldencode.p2j.util.FieldEntry

toArray

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

explicit

private boolean explicit

Contains an explicit column position.

num

private short num

An explicit column position. From experimental tests one can observe that Progress handles the number of Fields (CONTROL NULL, SPACE and SKIP) on a signed 16 bit memory space. Although Progress will accept any 64-bit value it will be automatically truncate it to short.

Constructor Detail

NullField

public NullField()

Default constructor (outputs a single space).

NullField

public NullField(long num)

Constructor for an explicit number of null characters.

Parameters:

num - The number of null characters to output.

Method Detail

output

public void output(Stream out)
            throws ErrorConditionException

Renders the contained field definition to the given stream.

Specified by:

output in class FieldEntry

Parameters:

out - The stream to which the field should be rendered.

Throws:

ErrorConditionException

resolveData

public void resolveData()

Notify instance that it is about to be transferred so all resolvable data should be resolved and prepared for sending via network.

Specified by:

resolveData in class FieldEntry

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Replacement for the default object reading method. The latest state is read from the input source.

Parameters:

in - The input source from which fields will be restored.

Throws:

java.io.IOException - In case of I/O errors.

java.lang.ClassNotFoundException - If payload can't be instantiated.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Replacement for the default object writing method. The latest state is written to the output destination.

Parameters:

out - The output destination to which fields will be saved.

Throws:

java.io.IOException - In case of I/O errors.

isExplicit

boolean isExplicit()

Get current value of explicit flag.

Returns:

The current value of flag.

getNum

int getNum()

Get explicit count.

Returns:

The explicit count.

setNum

protected void setNum(long num)

Set explicit count. The value is automatically truncated to 16-bit value.

Parameters:

num - The explicit count.

setExplicit

protected void setExplicit(boolean explicit)

Set value of explicit flag.

Parameters:

explicit - The value of flag.