public abstract class AbstractSwiftMessage
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
java.lang.String |
PROPERTY_NAME |
Constructor and Description |
---|
AbstractSwiftMessage() |
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(java.lang.Enum... statuses)
Tell if this message has any of the given statuses in his status trail
|
boolean |
contains(java.lang.String... statuses)
Tell if this message has any of the given statuses in his status trail
|
boolean |
equals(java.lang.Object obj) |
SwiftMessageStatusInfo |
findStatusInfo(java.lang.String statusName)
Finds the first status info from the status trail, with the given name or returns
null if not found |
java.lang.String |
getChecksum() |
java.util.Calendar |
getCreationDate() |
MessageIOType |
getDirection() |
java.lang.String |
getFilename() |
java.lang.Long |
getId() |
java.lang.String |
getIdentifier() |
java.lang.String |
getLastData() |
java.lang.String |
getLastData(java.lang.String... statuses)
Get the last saved status data of this message or empty string if not found
|
java.util.Calendar |
getLastModified() |
java.lang.String |
getMessage() |
java.lang.String |
getMessageName()
Get the value of the property under the
PROPERTY_NAME key or null if not found |
java.util.List<SwiftMessageNote> |
getNotes() |
java.lang.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. |
java.util.Map<java.lang.String,java.lang.String> |
getProperties() |
java.lang.String |
getProperty(java.lang.Enum key) |
java.lang.String |
getProperty(java.lang.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(java.lang.Enum key) |
boolean |
getPropertyBoolean(java.lang.String key)
Returns true if the message has a property with the given key name and value "true"
|
java.lang.String |
getReceiver() |
java.lang.String |
getSender() |
java.lang.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. |
java.util.List<SwiftMessageStatusInfo> |
getStatusTrail() |
int |
hashCode() |
java.lang.Boolean |
isIncoming() |
boolean |
isInput() |
boolean |
isOutgoing() |
java.lang.Boolean |
isOutput() |
boolean |
isStatus(java.lang.Enum... statuses)
Tell if this message has any of the given statuses as current status
|
boolean |
isStatus(java.lang.Enum status)
Returns true if the current status is equals to the parameter status
|
boolean |
isStatus(java.lang.String... statuses)
Tell if this message has any of the given statuses as current status
|
boolean |
isStatus(java.lang.String status)
Returns true if the current status is equals to the parameter status
|
abstract AbstractSwiftMessage |
readFile(java.io.File file) |
void |
sanityCheckProperties()
Iterate message properties and truncate all needed values issuing a log entry for each truncated one
|
void |
setChecksum(java.lang.String checksum) |
void |
setCreationDate(java.util.Calendar creationDate) |
void |
setDirection(MessageIOType direction) |
void |
setFilename(java.lang.String filename) |
void |
setId(java.lang.Long id) |
void |
setIdentifier(java.lang.String identifier) |
void |
setLastModified(java.util.Calendar lastModified) |
void |
setMessage(java.lang.String message)
Set the raw content of the message.
|
void |
setNotes(java.util.List<SwiftMessageNote> notes) |
void |
setProperties(java.util.Map<java.lang.String,java.lang.String> properties) |
void |
setProperty(java.lang.Enum key,
java.lang.String value) |
void |
setProperty(java.lang.String key,
java.lang.String value)
Sets a property using the given key and value, if the key exists the value is overwritten.
|
void |
setReceiver(java.lang.String receiver) |
void |
setSender(java.lang.String sender) |
void |
setStatus(java.lang.String status)
Sets the status attribute.
|
void |
setStatus(SwiftMessageStatusInfo status) |
void |
setStatusTrail(java.util.List<SwiftMessageStatusInfo> statusTrail) |
public void addNote(SwiftMessageNote n)
n
- note to addpublic void addStatus(SwiftMessageStatusInfo status)
status
- the status to addpublic boolean contains(java.lang.Enum... statuses)
statuses
- a list of statuses to check in the status trailpublic boolean contains(java.lang.String... statuses)
statuses
- a list of statuses to check in the status trailpublic boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public SwiftMessageStatusInfo findStatusInfo(java.lang.String statusName)
null
if not foundpublic java.lang.String getChecksum()
public java.util.Calendar getCreationDate()
public MessageIOType getDirection()
public java.lang.String getFilename()
public java.lang.Long getId()
public java.lang.String getIdentifier()
public java.lang.String getLastData()
public java.lang.String getLastData(java.lang.String... statuses)
statuses
- an array of statuses to check data into, if null
all message statuses are checked for datapublic java.util.Calendar getLastModified()
public java.lang.String getMessage()
public java.lang.String getMessageName()
PROPERTY_NAME
key or null
if not foundpublic java.util.List<SwiftMessageNote> getNotes()
public java.lang.String getPaddedId()
public SwiftMessageStatusInfo getPreviousStatusInfo()
null
if none is found.public java.util.Map<java.lang.String,java.lang.String> getProperties()
public java.lang.String getProperty(java.lang.Enum key)
getProperty(String)
public java.lang.String getProperty(java.lang.String key)
null
if the key is not found or its value is emptypublic boolean getPropertyBoolean(java.lang.Enum key)
getPropertyBoolean(String)
public boolean getPropertyBoolean(java.lang.String key)
public java.lang.String getReceiver()
public java.lang.String getSender()
public java.lang.String getStatus()
null
if none is found.public SwiftMessageStatusInfo getStatusInfo()
null
if none is found.public java.util.List<SwiftMessageStatusInfo> getStatusTrail()
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.Boolean isIncoming()
public boolean isInput()
isOutgoing()
public boolean isOutgoing()
public java.lang.Boolean isOutput()
isIncoming()
public boolean isStatus(java.lang.Enum... statuses)
statuses
- public boolean isStatus(java.lang.Enum status)
status
- public boolean isStatus(java.lang.String... statuses)
statuses
- public boolean isStatus(java.lang.String status)
status
- public abstract AbstractSwiftMessage readFile(java.io.File file) throws java.io.IOException
java.io.IOException
public void sanityCheckProperties()
public void setChecksum(java.lang.String checksum)
public void setCreationDate(java.util.Calendar creationDate)
public void setDirection(MessageIOType direction)
public void setFilename(java.lang.String filename)
public void setId(java.lang.Long id)
public void setIdentifier(java.lang.String identifier)
public void setLastModified(java.util.Calendar lastModified)
public void setMessage(java.lang.String message)
message
- raw content of the messagepublic void setNotes(java.util.List<SwiftMessageNote> notes)
public void setProperties(java.util.Map<java.lang.String,java.lang.String> properties)
public void setProperty(java.lang.Enum key, java.lang.String value)
setProperty(String, String)
public void setProperty(java.lang.String key, java.lang.String value)
public void setReceiver(java.lang.String receiver)
public void setSender(java.lang.String sender)
public void setStatus(java.lang.String status)
status
- addStatus(SwiftMessageStatusInfo)
public void setStatus(SwiftMessageStatusInfo status)
addStatus(SwiftMessageStatusInfo)
public void setStatusTrail(java.util.List<SwiftMessageStatusInfo> statusTrail)