Package com.atlassian.bamboo.migration

Interface BambooStAXMappingHelper<T,I extends 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, AccessTokenMapper, AceMapper, AclMapper, AgentAssignmentMapper, AliasMapper, ApplicationMapper, ApplicationMapper.DirectoryMappingsMapper, ApplicationMapper.GroupMappingsMapper, ArtifactDefinitionMapper, ArtifactLinkMapper, ArtifactMapper, ArtifactSubscriptionMapper, AuditLogMapper, AuthorMapper, BambooStAXMappingHelperAbstractImpl, BambooStAXMappingListHelperAbstractImpl, BandanaItemMapper, BuildDefinitionMapper, BuildNumberMapper, BuildResultSummaryMapper, BuildResultsWarningsSummariesMapper, BuildResultWarningSummaryMapper, CapabilitySetMapper, ChainBranchMapper, ChainBuildMapper, ChainMapper, ChainResultMapper, ChainStageMapper, ChainStageResultMapper, CommentMapper, CommentRootMapper, CommitFilesMapper, CommitMapper, CommitRootMapper, ConsumedSubscriptionMapper, CredentialMapper, CrowdDeletedEntityMapper, CrowdEntityXmlMapper, CrowdEntityXmlMapper.SingleValuedAttributesMapper, CustomBuildDataMapper, CustomDataMapper, DeploymentProjectItemMapper, DeploymentProjectMapper, DeploymentProjectPropertiesMapper, DeploymentResultCustomDataMapper, DeploymentResultMapper, DeploymentResultPropertiesMapper, DeploymentVersionItemMapper, DeploymentVersionLinkedJiraIssueMapper, DeploymentVersionMapper, DeploymentVersionPropertiesMapper, DeploymentVersionStatusMapper, DeploymentVersionVcsChangesetMapper, DeploymentVersionVcsCommitMapper, DirectoryMapper, DirectoryMapper.PermissionsMapper, ElasticImageConfigurationMapper, ElasticInstanceScheduleMapper, EnvironmentCustomConfigMapper, EnvironmentMapper, EnvironmentPropertiesMapper, EnvironmentRepositoryLinkMapper, EphemeralAgentTemplateMapper, ExternalEntityMapper, GroupMapper, GroupMapper.GroupAttributeMapper, IdGeneratorMapper, InstantMessagingServerMapper, JobMapper, LabellingMapper, LabelMapper, LinkedJiraIssueRootMapper, LinkedJiraIssuesMapper, LocalCapabilitySetMapper, LocalGroupMapper, LocalUserMapper, MailServerMapper, MembershipMapper, NotificationRuleMapper, NotificationSetMapper, PartialCrowdEntityXmlMapper, PipelineMapper, PlanBranchPullRequestMapper, PlanBuildNumbersMapper, PlanRepositoryLinkMapper, PlanResultKeyListMapper, PlanSpecsSourceMapper, PlanVcsRevisionHistoryMapper, ProjectChainMapper, ProjectDependencyMapper, ProjectMapper, PropertyEntryMapper, PullRequestMapper, QuickFilterMapper, QuickFilterRuleMapper, RelevantChangesetsMapper, RemoteAgentAuthenticationMapper, RemoteCapabilitySetMapper, RepositoryChangesetMapper, RepositoryDefinitionMapper, RequirementMapper, RequirementSetMapper, RssDeploymentProjectPermissionsMapper, RssProjectPermissionsMapper, ScriptMapper, ServerIDMapper, SharedCapabilityMapper, SpecsSourceMapper, SpecsStateMapper, StageVariableContextMapper, StringListMapper, TestCaseMapper, TestCaseResultErrorMapper, TestCaseResultMapper, TestClassMapper, TestClassResultMapper, TrustedApplicationsMapper, TrustedKeyMapper, UserMapper, UserMapper.CredentialsRecordsMapper, UserMapper.UserAttributesMapper, VariableBaselineItemMapper, VariableContextBaselineMapper, VariableContextBaselinePropertiesMapper, VariableContextSnapshotMapper, VariableDefinitionMapper, VariableSubstitutionMapper, VcsBranchMapper, VersionNamingSchemeMapper, WebhookTemplateMapper
public interface BambooStAXMappingHelper<T,I extends T>
Base interface for StAX based export-import helper class

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    BambooStAXMappingHelper.None
     

  • Method Summary

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

  • Method Details

    • getXmlRootNodeName

      @NotNull @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 @NotNull org.hibernate.Session session, @NotNull @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

      I importXml(@NotNull @NotNull org.hibernate.Session session, @NotNull @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