com.atlassian.bamboo.migration

Interface BambooStAXMappingHelper<T>

Type Parameters:

T - a class/interface which can be exported/imported by the implementer of this interface

All Known Implementing Classes:

AbstractChainMapper, AbstractPlanMapper, AbstractProjectDependencyMapper, AbstractProjectMapper, AbstractResultSummaryMapper, AceMapper, AclMapper, AgentAssignmentMapper, ArtifactDefinitionMapper, ArtifactLinkMapper, ArtifactMapper, ArtifactSubscriptionMapper, AuditLogMapper, AuthorMapper, BambooStAXMappingHelperAbstractImpl, BambooStAXMappingListHelperAbstractImpl, BandanaItemMapper, BuildDefinitionMapper, BuildNumberMapper, BuildResultSummaryMapper, CapabilitySetMapper, ChainBranchMapper, ChainBuildMapper, ChainMapper, ChainResultMapper, ChainStageMapper, CommentMapper, CommentRootMapper, CommitFilesMapper, CommitMapper, CommitRootMapper, ConsumedSubscriptionMapper, CredentialMapper, CustomBuildDataMapper, CustomDataMapper, DeploymentProjectItemMapper, DeploymentProjectMapper, DeploymentProjectPropertiesMapper, DeploymentResultCustomDataMapper, DeploymentResultMapper, DeploymentResultPropertiesMapper, DeploymentVersionItemMapper, DeploymentVersionLinkedJiraIssueMapper, DeploymentVersionMapper, DeploymentVersionPropertiesMapper, DeploymentVersionStatusMapper, DeploymentVersionVcsChangesetMapper, DeploymentVersionVcsCommitMapper, ElasticImageConfigurationMapper, ElasticInstanceScheduleMapper, EnvironmentMapper, EnvironmentPropertiesMapper, EnvironmentRepositoryLinkMapper, ExternalEntityMapper, GroupMemberMapper, IdGeneratorMapper, InstantMessagingServerMapper, JiraIssuesMapper, JobMapper, LabellingMapper, LabelMapper, LegacyArtifactMapper, LegacyJiraServerMapper, LegacyRequirementMapper, LinkedJiraIssueRootMapper, LinkedJiraIssuesMapper, LocalCapabilitySetMapper, LocalGroupMapper, LocalUserMapper, MailServerMapper, NotificationRuleMapper, NotificationSetMapper, PipelineMapper, PlanBranchPullRequestMapper, PlanBuildNumbersMapper, PlanRepositoryLinkMapper, PlanResultKeyListMapper, PlanVcsRevisionHistoryMapper, ProjectChainMapper, ProjectDependencyMapper, ProjectMapper, PropertyEntryMapper, PullRequestMapper, RelevantChangesetsMapper, RemoteAgentAuthenticationMapper, RemoteCapabilitySetMapper, RepositoryChangesetMapper, RepositoryDefinitionMapper, RequirementMapper, RequirementSetMapper, ScriptMapper, ServerIDMapper, SharedCapabilityMapper, StageVariableContextMapper, TestCaseMapper, TestCaseResultErrorMapper, TestCaseResultMapper, TestClassMapper, TestClassResultMapper, TrustedApplicationsMapper, TrustedKeyMapper, VariableBaselineItemMapper, VariableContextBaselineMapper, VariableContextBaselinePropertiesMapper, VariableContextSnapshotMapper, VariableDefinitionMapper, VariableSubstitutionMapper, VcsBranchMapper, VersionNamingSchemeMapper

public interface BambooStAXMappingHelper<T>

Base interface for StAX based export-import helper class

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BambooStAXMappingHelper.None

Method Summary

Modifier and Type	Method and Description
void	exportXml(org.hibernate.Session session, org.codehaus.staxmate.out.SMOutputElement outputElement, T object, ExportDetailsBean exportDetailsBean) Export object using StaxMate's SMOutputElement.
String	getXmlRootNodeName() Returns local name of the XML parent node that will contain exported/imported object's properties
T	importXml(org.hibernate.Session session, org.codehaus.staxmate.in.SMInputCursor inputCursor) Import object using StaxMate's SMInputCursor.

Method Detail

getXmlRootNodeName

@NotNull
String getXmlRootNodeName()

Returns local name of the XML parent node that will contain exported/imported object's properties

Returns:

local name of the XML parent node

exportXml

void exportXml(@NotNull
               org.hibernate.Session session,
               @NotNull
               org.codehaus.staxmate.out.SMOutputElement outputElement,
               @NotNull
               T object,
               ExportDetailsBean exportDetailsBean)
        throws Exception

Export object using StaxMate's SMOutputElement. It is responsibility of the exporter to create parent node for the object being exported.

Parameters:

session - Hibernate session object

outputElement - an element at which exported should create a node to export data

object - object being exported

exportDetailsBean -

Throws:

Exception - when something went wrong

importXml

T importXml(@NotNull
            org.hibernate.Session session,
            @NotNull
            org.codehaus.staxmate.in.SMInputCursor inputCursor)
     throws Exception

Import object using StaxMate's SMInputCursor.

Parameters:

session - Hibernate session object

inputCursor - a inputCursor that points to the parent node containing object properties

Returns:

an imported object

Throws:

Exception - when something went wrong