Skip to content

Commit

Permalink
Pull request #841: [ROCKSOLID-12899] updates to descriptions of the m…
Browse files Browse the repository at this point in the history 
…ethods of attachment util

Merge in MC/connect from ROCKSOLID-12899-updateattutil to development

* commit 'e233d9af6865e2c4f2a27c3f940361f7f00e3414':
  update per code review
  [ROCKSOLID-12899] updates to descriptions of the methods of attachment util
  • Loading branch information
@joaryche @narupley
joaryche authored and narupley committed Jun 27, 2024
2 parents ce1bfbb + e233d9a commit 80a8c84
Showing 1 changed file with 28 additions and 30 deletions.
58 changes: 28 additions & 30 deletions server/src/com/mirth/connect/server/userutil/AttachmentUtil.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ public static String reAttachMessage(String raw, ImmutableConnectorMessage conne
}

/**
* Returns a List of attachment IDs associated with the current channel / message.
* Returns a list of attachment IDs associated with the current connector message.
*
* @param connectorMessage
* The ConnectorMessage associated with this message, used to identify the
Expand All @@ -127,7 +127,7 @@ public static List<String> getMessageAttachmentIds(ImmutableConnectorMessage con
}

/**
* Returns a List of attachment IDs associated with the current channel / message.
* Returns a list of attachment IDs associated with the current channel / message.
*
* @param channelId
* The ID of the channel the attachments are associated with.
Expand All @@ -142,7 +142,7 @@ public static List<String> getMessageAttachmentIds(String channelId, Long messag
}

/**
* Retrieves all attachments associated with a connector message.
* Retrieves a list of all attachments associated with a connector message.
*
* @param connectorMessage
* The ConnectorMessage associated with this message, used to identify the
Expand All @@ -156,7 +156,7 @@ public static List<Attachment> getMessageAttachments(ImmutableConnectorMessage c
}

/**
* Retrieves all attachments associated with a connector message.
* Retrieves a list of all attachments associated with a connector message with an additional option to Base64 decode the content.
*
* @param connectorMessage
* The ConnectorMessage associated with this message, used to identify the
Expand All @@ -173,7 +173,7 @@ public static List<Attachment> getMessageAttachments(ImmutableConnectorMessage c
}

/**
* Retrieves all attachments associated with a specific channel/message ID.
* Retrieves a list of all attachments associated with a specific channel/message ID.
*
* @param channelId
* The ID of the channel to retrieve the attachments from.
Expand All @@ -189,7 +189,7 @@ public static List<Attachment> getMessageAttachments(String channelId, Long mess
}

/**
* Retrieves all attachments associated with a specific channel/message ID.
* Retrieves a list of all attachments associated with a specific channel/message ID with an additional option to Base64 decode the content.
*
* @param channelId
* The ID of the channel to retrieve the attachments from.
Expand All @@ -208,7 +208,7 @@ public static List<Attachment> getMessageAttachments(String channelId, Long mess
}

/**
* Retrieves an attachment from the current channel/message ID.
* Retrieves an attachment associated with a given connector message and attachment ID.
*
* @param connectorMessage
* The ConnectorMessage associated with this message, used to identify the
Expand All @@ -225,7 +225,7 @@ public static Attachment getMessageAttachment(ImmutableConnectorMessage connecto
}

/**
* Retrieves an attachment from the current channel/message ID.
* Retrieves an attachment associated with a given connector message and attachment ID with an additional option to Base64 decode the content.
*
* @param connectorMessage
* The ConnectorMessage associated with this message, used to identify the
Expand All @@ -245,7 +245,7 @@ public static Attachment getMessageAttachment(ImmutableConnectorMessage connecto
}

/**
* Retrieves an attachment from a specific channel/message ID.
* Retrieves an attachment associated with a given channel/message/attachment ID.
*
* @param channelId
* The ID of the channel to retrieve the attachment from.
Expand All @@ -264,7 +264,7 @@ public static Attachment getMessageAttachment(String channelId, Long messageId,
}

/**
* Retrieves an attachment from a specific channel/message ID.
* Retrieves an attachment associated with a given channel/message/attachment ID with an additional option to Base64 decode the content.
*
* @param channelId
* The ID of the channel to retrieve the attachment from.
Expand All @@ -286,7 +286,7 @@ public static Attachment getMessageAttachment(String channelId, Long messageId,
}

/**
* Retrieves an attachment from an upstream channel that sent a message to the current channel.
* Retrieves a list of attachments from an upstream channel that sent a message to the current channel.
*
* @param connectorMessage
* The ConnectorMessage associated with this message. The channel ID and message ID
Expand All @@ -301,7 +301,7 @@ public static List<Attachment> getMessageAttachmentsFromSourceChannel(ImmutableC
}

/**
* Retrieves an attachment from an upstream channel that sent a message to the current channel.
* Retrieves a list of attachments from an upstream channel that sent a message to the current channel with an additional option to Base64 decode the content.
*
* @param connectorMessage
* The ConnectorMessage associated with this message. The channel ID and message ID
Expand Down Expand Up @@ -339,7 +339,7 @@ public static List<Attachment> getMessageAttachmentsFromSourceChannel(ImmutableC
}

/**
* Creates an Attachment and adds it to the provided list.
* Creates an attachment and adds it to the provided list.
*
* @param attachments
* The list of attachments to add to.
Expand All @@ -356,7 +356,7 @@ public static Attachment addAttachment(List<Attachment> attachments, Object cont
}

/**
* Creates an Attachment and adds it to the provided list.
* Creates an attachment and adds it to the provided list with an additional option to Base64 encode the content.
*
* @param attachments
* The list of attachments to add to.
Expand All @@ -379,8 +379,7 @@ public static Attachment addAttachment(List<Attachment> attachments, Object cont
}

/**
* Creates an attachment associated with a given connector message, and inserts it into the
* database.
* Creates an attachment associated with a given connector message and inserts it into the database.
*
* @param connectorMessage
* The connector message to be associated with the attachment.
Expand All @@ -397,8 +396,7 @@ public static Attachment createAttachment(ImmutableConnectorMessage connectorMes
}

/**
* Creates an attachment associated with a given connector message, and inserts it into the
* database.
* Creates an attachment associated with a given connector message with an additional option to Base64 encode the content and inserts it into the database.
*
* @param connectorMessage
* The connector message to be associated with the attachment.
Expand All @@ -421,8 +419,8 @@ public static Attachment createAttachment(ImmutableConnectorMessage connectorMes
}

/**
* Updates an attachment associated with a given connector message.
*
* Updates an attachment associated with a given connector message and attachment ID.
*
* @param connectorMessage
* The connector message to be associated with the attachment.
* @param attachmentId
Expand All @@ -441,8 +439,8 @@ public static Attachment updateAttachment(ImmutableConnectorMessage connectorMes
}

/**
* Updates an attachment associated with a given connector message.
*
* Updates an attachment associated with a given connector message and attachment ID with an additional option to Base64 encode the content.
*
* @param connectorMessage
* The connector message to be associated with the attachment.
* @param attachmentId
Expand All @@ -465,7 +463,7 @@ public static Attachment updateAttachment(ImmutableConnectorMessage connectorMes

/**
* Updates an attachment associated with a given connector message.
*
*
* @param connectorMessage
* The connector message to be associated with the attachment.
* @param attachment
Expand All @@ -480,8 +478,8 @@ public static Attachment updateAttachment(ImmutableConnectorMessage connectorMes
}

/**
* Updates an attachment associated with a given connector message.
*
* Updates an attachment associated with a given connector message with an additional option to Base64 encode the content.
*
* @param connectorMessage
* The connector message to be associated with the attachment.
* @param attachment
Expand All @@ -499,7 +497,7 @@ public static Attachment updateAttachment(ImmutableConnectorMessage connectorMes
}

/**
* Updates an attachment associated with a given connector message.
* Updates an attachment associated with a specific channel/message ID.
*
* @param channelId
* The ID of the channel the attachment is associated with.
Expand All @@ -517,8 +515,8 @@ public static Attachment updateAttachment(String channelId, Long messageId, Atta
}

/**
* Updates an attachment associated with a given connector message.
*
* Updates an attachment associated with a specific channel/message ID with an additional option to Base64 encode the content.
*
* @param channelId
* The ID of the channel the attachment is associated with.
* @param messageId
Expand All @@ -538,7 +536,7 @@ public static Attachment updateAttachment(String channelId, Long messageId, Atta
}

/**
* Updates an attachment associated with a given connector message.
* Updates an attachment associated with a specific channel/message/attachment ID with given content.
*
* @param channelId
* The ID of the channel the attachment is associated with.
Expand All @@ -560,7 +558,7 @@ public static Attachment updateAttachment(String channelId, Long messageId, Stri
}

/**
* Updates an attachment associated with a given connector message.
* Updates an attachment associated with a specific channel/message/attachment ID with given content with an additional option to Base64 encode the content.
*
* @param channelId
* The ID of the channel the attachment is associated with.
Expand Down

0 comments on commit 80a8c84

Please sign in to comment.