org.openlowcode.tools.structure

Class FaultyTextDataElt

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.tools.structure.DataElt

org.openlowcode.tools.structure.SimpleDataElt

org.openlowcode.tools.structure.FaultyTextDataElt

All Implemented Interfaces:

NamedInterface

public class FaultyTextDataElt
extends SimpleDataElt

a simple element storing a faulty text information. This will generate an exception when being decoded to allow trouble shooting and transmissions.

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Modifier	Constructor and Description
	FaultyTextDataElt(java.lang.String name) creates a text element with no payload
	FaultyTextDataElt(java.lang.String name, java.lang.String payload) creates a text data element
protected	FaultyTextDataElt(java.lang.String name, java.lang.String payload, TextDataEltType type)
protected	FaultyTextDataElt(java.lang.String name, TextDataEltType type)

Method Summary

Modifier and Type	Method and Description
void	addPayload(MessageReader reader) for each element, should read and add content for all elements between the "TYP" field (excluded) and the "DELT" structure end (also excluded)
void	changePayload(java.lang.String payload) changes the payload of the element
FaultyTextDataElt	cloneElt() makes a deep copy of the element
java.lang.String	defaultTextRepresentation()
boolean	equals(java.lang.Object other)
void	forceContent(java.lang.String constraintvalue)
protected java.lang.Object	getMessageArrayValue()
protected MessageFieldSpec	getMessageFieldSpec()
java.lang.String	getPayload()
void	writePayload(MessageWriter writer) writes the payload for network transport

Methods inherited from class org.openlowcode.tools.structure.SimpleDataElt

getEltCreator, getPropertyname, setPropertyname, toString, WriteSpecToMessage, writeToMessage, writeToMessage

Methods inherited from class org.openlowcode.tools.structure.DataElt

getType, readFromCML, writeReferenceToCML

Methods inherited from class org.openlowcode.tools.misc.Named

changeName, cleanName, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

FaultyTextDataElt

public FaultyTextDataElt(java.lang.String name,
                         java.lang.String payload)

creates a text data element

Parameters:

name - name of the element

payload - payload

FaultyTextDataElt

protected FaultyTextDataElt(java.lang.String name,
                            java.lang.String payload,
                            TextDataEltType type)

FaultyTextDataElt

public FaultyTextDataElt(java.lang.String name)

creates a text element with no payload

Parameters:

name - name of the element

FaultyTextDataElt

protected FaultyTextDataElt(java.lang.String name,
                            TextDataEltType type)

Method Detail

changePayload

public void changePayload(java.lang.String payload)

changes the payload of the element

Parameters:

payload - the new payload

writePayload

public void writePayload(MessageWriter writer)
                  throws java.io.IOException

Description copied from class: SimpleDataElt

writes the payload for network transport

Specified by:

writePayload in class SimpleDataElt

Parameters:

writer - writer

Throws:

java.io.IOException - if anything wrongs happens in the message sending

getPayload

public java.lang.String getPayload()

Returns:

the payload

addPayload

public void addPayload(MessageReader reader)
                throws OLcRemoteException,
                       java.io.IOException

Description copied from class: DataElt

for each element, should read and add content for all elements between the "TYP" field (excluded) and the "DELT" structure end (also excluded)

Overrides:

addPayload in class SimpleDataElt

Parameters:

reader - reader

Throws:

OLcRemoteException - if anything happened to the other party

java.io.IOException - if any communication error happens

defaultTextRepresentation

public java.lang.String defaultTextRepresentation()

Specified by:

defaultTextRepresentation in class SimpleDataElt

Returns:

a simple text representation for audit and log purposes

cloneElt

public FaultyTextDataElt cloneElt()

Description copied from class: SimpleDataElt

makes a deep copy of the element

Specified by:

cloneElt in class SimpleDataElt

Returns:

the deep copy

forceContent

public void forceContent(java.lang.String constraintvalue)

Specified by:

forceContent in class SimpleDataElt

Parameters:

constraintvalue - force the content in payload. May not be implemented for all the types

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class Named

getMessageFieldSpec

protected MessageFieldSpec getMessageFieldSpec()

Specified by:

getMessageFieldSpec in class SimpleDataElt

Returns:

gets the Message Field Spec

getMessageArrayValue

protected java.lang.Object getMessageArrayValue()

Specified by:

getMessageArrayValue in class SimpleDataElt

Returns:

the vale of an object in the message array