com.atlassian.jira.imports.project.parser
Interface CommentParser

All Known Implementing Classes:
CommentParserImpl

public interface CommentParser

Converts comment xml in a JIRA backup to an object representation and converts the object representation into EntityRepresentation.

Since:
v3.13

Field Summary
static String COMMENT_ENTITY_NAME
           
 
Method Summary
 EntityRepresentation getEntityRepresentation(ExternalComment comment)
          Gets an EntityRepresentation that contains the correct attributes based on the populated fields in the provided comment.
 ExternalComment parse(Map attributes)
          Parses the comment data from the backup XML.
 

Field Detail

COMMENT_ENTITY_NAME

static final String COMMENT_ENTITY_NAME
See Also:
Constant Field Values
Method Detail

parse

ExternalComment parse(Map attributes)
                      throws ParseException
Parses the comment data from the backup XML.

Parameters:
attributes - is a map of key value pairs that represent the attributes of an ExternalComment. The following attributes are required, otherwise a ParseException will be thrown:
  • id (required)
  • issue (required)
Returns:
an ExternalComment if the attributes contain the required fields
Throws:
ParseException - if the required fields are not found in the attributes map

getEntityRepresentation

EntityRepresentation getEntityRepresentation(ExternalComment comment)
Gets an EntityRepresentation that contains the correct attributes based on the populated fields in the provided comment.

Parameters:
comment - contains the populated fields that will end up in the EntityRepresentations map
Returns:
an EntityRepresentation that can be persisted using OfBiz


Copyright © 2002-2013 Atlassian. All Rights Reserved.