com.atlassian.jira.imports.project.parser
Class AttachmentParserImpl

java.lang.Object
  extended by com.atlassian.jira.imports.project.parser.AttachmentParserImpl
All Implemented Interfaces:
AttachmentParser

public class AttachmentParserImpl
extends java.lang.Object
implements AttachmentParser

Since:
v3.13

Field Summary
 
Fields inherited from interface com.atlassian.jira.imports.project.parser.AttachmentParser
ATTACHMENT_ENTITY_NAME
 
Constructor Summary
AttachmentParserImpl()
           
 
Method Summary
 java.lang.String getFileAttachmentUrl(ExternalAttachment attachment, java.lang.String attachmentPath, java.lang.String projectKey, java.lang.String issueKey)
          Returns the full path, on disk, to where the attachment file should be stored based on the provided inputs.
 ExternalAttachment parse(java.util.Map<java.lang.String,java.lang.String> attributes)
          Parses the file attachment data from the backup XML.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AttachmentParserImpl

public AttachmentParserImpl()
Method Detail

parse

public ExternalAttachment parse(java.util.Map<java.lang.String,java.lang.String> attributes)
                         throws ParseException
Description copied from interface: AttachmentParser
Parses the file attachment data from the backup XML.

Specified by:
parse in interface AttachmentParser
Parameters:
attributes - is a map of key value pairs that represent the attributes of an ExternalAttachment. The following attributes are required, otherwise a ParseException will be thrown:
  • id (required)
  • issue (required)
  • filename (required)
  • created (required)
An optional attribute is:
  • author
Returns:
an ExternalAttachment if the attributes contain the required fields
Throws:
ParseException - if the required fields are not found in the attributes map

getFileAttachmentUrl

public java.lang.String getFileAttachmentUrl(ExternalAttachment attachment,
                                             java.lang.String attachmentPath,
                                             java.lang.String projectKey,
                                             java.lang.String issueKey)
Description copied from interface: AttachmentParser
Returns the full path, on disk, to where the attachment file should be stored based on the provided inputs.

Specified by:
getFileAttachmentUrl in interface AttachmentParser
Parameters:
attachment - represents the database row for an attachment from the backup.
attachmentPath - is the path, on disk, the user has specified that should contain all attachments.
projectKey - the backup project key, used to determine the path to the attachment file.
issueKey - the issue key that the attachment is associated with, used to determine the path to the attachment file.
Returns:
the full path, on disk, to where the attachment file should be stored based on the provided inputs.


Copyright © 2002-2010 Atlassian. All Rights Reserved.