AbstractSwiftMessage

java.lang.Object
- com.prowidesoftware.swift.model.AbstractSwiftMessage

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MtSwiftMessage, MxSwiftMessage
```
public abstract class AbstractSwiftMessage
extends Object
implements Serializable
```
Base class for common attributes of MT and MX SWIFT messages.
Most of the attributes are derived from the raw message, so it is an application responsibility to grant consistency of the redundant information.

Since:

7.0

Author:

www.prowidesoftware.com

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String PROPERTY_NAME

Fields
Modifier and Type	Field and Description
`static String`	`PROPERTY_NAME`

Constructor Summary

Constructors
Constructor and Description

AbstractSwiftMessage()

Constructors
Constructor and Description
`AbstractSwiftMessage()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addNote(SwiftMessageNote n)` Adds a new note to the messages, initializing the notes list if necessary.
`void`	`addStatus(SwiftMessageStatusInfo status)` Adds a status to the message's status trail and current status attribute, initializing the statuses trail list if necessary.
`boolean`	`contains(Enum... statuses)` Tell if this message has any of the given statuses in his status trail
`boolean`	`contains(String... statuses)` Tell if this message has any of the given statuses in his status trail
`boolean`	`equals(Object obj)`
`SwiftMessageStatusInfo`	`findStatusInfo(String statusName)` Finds the first status info from the status trail, with the given name or returns `null` if not found
`String`	`getChecksum()`
`Calendar`	`getCreationDate()`
`MessageIOType`	`getDirection()`
`String`	`getFilename()`
`Long`	`getId()`
`String`	`getIdentifier()`
`String`	`getLastData()`
`String`	`getLastData(String... statuses)` Get the last saved status data of this message or empty string if not found
`Calendar`	`getLastModified()`
`String`	`getMessage()`
`String`	`getMessageName()` Get the value of the property under the `PROPERTY_NAME` key or `null` if not found
`List<SwiftMessageNote>`	`getNotes()`
`String`	`getPaddedId()` Returns the internal unique id as fixed length string, padded with zeros.
`SwiftMessageStatusInfo`	`getPreviousStatusInfo()` Retrieves from the status trail, the status info before the current one; or `null` if none is found.
`Map<String,String>`	`getProperties()`
`String`	`getProperty(Enum key)`
`String`	`getProperty(String key)` Get the value of the property under the given key or `null` if the key is not found or its value is empty
`boolean`	`getPropertyBoolean(Enum key)`
`boolean`	`getPropertyBoolean(String key)` Returns true if the message has a property with the given key name and value "true"
`String`	`getReceiver()`
`String`	`getSender()`
`String`	`getStatus()` Get the name of the last status set to this message, or `null` if none is found.
`SwiftMessageStatusInfo`	`getStatusInfo()` Retrieves from the status trail, the current status info; or `null` if none is found.
`List<SwiftMessageStatusInfo>`	`getStatusTrail()`
`int`	`hashCode()`
`Boolean`	`isIncoming()`
`boolean`	`isInput()`
`boolean`	`isOutgoing()`
`Boolean`	`isOutput()`
`boolean`	`isStatus(Enum... statuses)` Tell if this message has any of the given statuses as current status
`boolean`	`isStatus(Enum status)` Returns true if the current status is equals to the parameter status
`boolean`	`isStatus(String... statuses)` Tell if this message has any of the given statuses as current status
`boolean`	`isStatus(String status)` Returns true if the current status is equals to the parameter status
`abstract AbstractSwiftMessage`	`readFile(File file)`
`void`	`sanityCheckProperties()` Iterate message properties and truncate all needed values issuing a log entry for each truncated one
`void`	`setChecksum(String checksum)`
`void`	`setCreationDate(Calendar creationDate)`
`void`	`setDirection(MessageIOType direction)`
`void`	`setFilename(String filename)`
`void`	`setId(Long id)`
`void`	`setIdentifier(String identifier)`
`void`	`setLastModified(Calendar lastModified)`
`void`	`setMessage(String message)` Set the raw content of the message.
`void`	`setNotes(List<SwiftMessageNote> notes)`
`void`	`setProperties(Map<String,String> properties)`
`void`	`setProperty(Enum key, String value)`
`void`	`setProperty(String key, String value)` Sets a property using the given key and value, if the key exists the value is overwritten.
`void`	`setReceiver(String receiver)`
`void`	`setSender(String sender)`
`void`	`setStatus(String status)` Sets the status attribute.
`void`	`setStatus(SwiftMessageStatusInfo status)`
`void`	`setStatusTrail(List<SwiftMessageStatusInfo> statusTrail)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROPERTY_NAME
```
public static final transient String PROPERTY_NAME
```
    See Also:
    Constant Field Values
- Constructor Detail
  - AbstractSwiftMessage
```
public AbstractSwiftMessage()
```
- Method Detail
  - addNote
```
public void addNote(SwiftMessageNote n)
```
    Adds a new note to the messages, initializing the notes list if necessary.
    
    Parameters:
    n - note to add
  - addStatus
```
public void addStatus(SwiftMessageStatusInfo status)
```
    Adds a status to the message's status trail and current status attribute, initializing the statuses trail list if necessary.
    
    Parameters:
    status - the status to add
  - contains
```
public boolean contains(Enum... statuses)
```
    Tell if this message has any of the given statuses in his status trail
    
    Parameters:
    statuses - a list of statuses to check in the status trail
  - contains
```
public boolean contains(String... statuses)
```
    Tell if this message has any of the given statuses in his status trail
    
    Parameters:
    statuses - a list of statuses to check in the status trail
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - findStatusInfo
```
public SwiftMessageStatusInfo findStatusInfo(String statusName)
```
    Finds the first status info from the status trail, with the given name or returns null if not found
  - getChecksum
```
public String getChecksum()
```
  - getCreationDate
```
public Calendar getCreationDate()
```
  - getDirection
```
public MessageIOType getDirection()
```
  - getFilename
```
public String getFilename()
```
  - getId
```
public Long getId()
```
  - getIdentifier
```
public String getIdentifier()
```
  - getLastData
```
public String getLastData()
```
  - getLastData
```
public String getLastData(String... statuses)
```
    Get the last saved status data of this message or empty string if not found
    
    Parameters:
    statuses - an array of statuses to check data into, if null all message statuses are checked for data
    
    Returns:
    the most recent (last) status data found
  - getLastModified
```
public Calendar getLastModified()
```
  - getMessage
```
public String getMessage()
```
  - getMessageName
```
public String getMessageName()
```
    Get the value of the property under the PROPERTY_NAME key or null if not found
  - getNotes
```
public List<SwiftMessageNote> getNotes()
```
  - getPaddedId
```
public String getPaddedId()
```
    Returns the internal unique id as fixed length string, padded with zeros.
    
    Returns:
    string with 10 characters with this message identifier
  - getPreviousStatusInfo
```
public SwiftMessageStatusInfo getPreviousStatusInfo()
```
    Retrieves from the status trail, the status info before the current one; or null if none is found.
  - getProperties
```
public Map<String,String> getProperties()
```
  - getProperty
```
public String getProperty(Enum key)
```
    See Also:
    getProperty(String)
  - getProperty
```
public String getProperty(String key)
```
    Get the value of the property under the given key or null if the key is not found or its value is empty
  - getPropertyBoolean
```
public boolean getPropertyBoolean(Enum key)
```
    See Also:
    getPropertyBoolean(String)
  - getPropertyBoolean
```
public boolean getPropertyBoolean(String key)
```
    Returns true if the message has a property with the given key name and value "true"
  - getReceiver
```
public String getReceiver()
```
  - getSender
```
public String getSender()
```
  - getStatus
```
public String getStatus()
```
    Get the name of the last status set to this message, or null if none is found.
  - getStatusInfo
```
public SwiftMessageStatusInfo getStatusInfo()
```
    Retrieves from the status trail, the current status info; or null if none is found.
  - getStatusTrail
```
public List<SwiftMessageStatusInfo> getStatusTrail()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isIncoming
```
public Boolean isIncoming()
```
    Returns:
    true if the message is incoming (received from SWIFT), false other case; using the direction attribute.
  - isInput
```
public boolean isInput()
```
    See Also:
    isOutgoing()
  - isOutgoing
```
public boolean isOutgoing()
```
    Returns:
    true if the message is outgoing (sent to SWIFT), false other case; using the direction attribute.
  - isOutput
```
public Boolean isOutput()
```
    See Also:
    isIncoming()
  - isStatus
```
public boolean isStatus(Enum... statuses)
```
    Tell if this message has any of the given statuses as current status
    
    Parameters:
    statuses -
  - isStatus
```
public boolean isStatus(Enum status)
```
    Returns true if the current status is equals to the parameter status
    
    Parameters:
    status -
  - isStatus
```
public boolean isStatus(String... statuses)
```
    Tell if this message has any of the given statuses as current status
    
    Parameters:
    statuses -
  - isStatus
```
public boolean isStatus(String status)
```
    Returns true if the current status is equals to the parameter status
    
    Parameters:
    status -
  - readFile
```
public abstract AbstractSwiftMessage readFile(File file)
                                       throws IOException
```
    Throws:
    
    IOException
  - sanityCheckProperties
```
public void sanityCheckProperties()
```
    Iterate message properties and truncate all needed values issuing a log entry for each truncated one
  - setChecksum
```
public void setChecksum(String checksum)
```
  - setCreationDate
```
public void setCreationDate(Calendar creationDate)
```
  - setDirection
```
public void setDirection(MessageIOType direction)
```
  - setFilename
```
public void setFilename(String filename)
```
  - setId
```
public void setId(Long id)
```
  - setIdentifier
```
public void setIdentifier(String identifier)
```
  - setLastModified
```
public void setLastModified(Calendar lastModified)
```
  - setMessage
```
public void setMessage(String message)
```
    Set the raw content of the message.
    
    Parameters:
    message - raw content of the message
  - setNotes
```
public void setNotes(List<SwiftMessageNote> notes)
```
  - setProperties
```
public void setProperties(Map<String,String> properties)
```
  - setProperty
```
public void setProperty(Enum key,
               String value)
```
    See Also:
    setProperty(String, String)
  - setProperty
```
public void setProperty(String key,
               String value)
```
    Sets a property using the given key and value, if the key exists the value is overwritten.
  - setReceiver
```
public void setReceiver(String receiver)
```
  - setSender
```
public void setSender(String sender)
```
  - setStatus
```
public void setStatus(String status)
```
    Sets the status attribute. Notice that this method does not update the status trail.
    
    Parameters:
    status -
    See Also:
    addStatus(SwiftMessageStatusInfo)
  - setStatus
```
public void setStatus(SwiftMessageStatusInfo status)
```
    See Also:
    addStatus(SwiftMessageStatusInfo)
  - setStatusTrail
```
public void setStatusTrail(List<SwiftMessageStatusInfo> statusTrail)
```

Class AbstractSwiftMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROPERTY_NAME

Constructor Detail

AbstractSwiftMessage

Method Detail

addNote

addStatus

contains

contains

equals

findStatusInfo

getChecksum

getCreationDate

getDirection

getFilename

getId

getIdentifier

getLastData

getLastData

getLastModified

getMessage

getMessageName

getNotes

getPaddedId

getPreviousStatusInfo

getProperties

getProperty

getProperty

getPropertyBoolean

getPropertyBoolean

getReceiver

getSender

getStatus

getStatusInfo

getStatusTrail

hashCode

isIncoming

isInput

isOutgoing

isOutput

isStatus

isStatus

isStatus

isStatus

readFile

sanityCheckProperties

setChecksum

setCreationDate

setDirection

setFilename

setId

setIdentifier

setLastModified

setMessage

setNotes

setProperties

setProperty

setProperty

setReceiver

setSender

setStatus

setStatus

setStatusTrail