com.atlassian.bamboo.migration.stream
Class VariableSubstitutionMapper

java.lang.Object
  com.atlassian.bamboo.migration.BambooStAXMappingHelperAbstractImpl<T>
      com.atlassian.bamboo.migration.BambooStAXMappingListHelperAbstractImpl<VariableSubstitution>
          com.atlassian.bamboo.migration.stream.VariableSubstitutionMapper

All Implemented Interfaces:

BambooStAXMappingHelper<VariableSubstitution>, BambooStAXRootMapper

public class VariableSubstitutionMapper
extends BambooStAXMappingListHelperAbstractImpl<VariableSubstitution>
implements BambooStAXRootMapper

Constructor Summary

VariableSubstitutionMapper(net.sf.hibernate.SessionFactory sessionFactory, BuildResultsSummaryDao buildResultsSummaryDao)

Method Summary

void	afterImportListItem(org.codehaus.staxmate.in.SMInputCursor cursor, java.util.List<VariableSubstitution> list, VariableSubstitution object, long objectIndex, net.sf.hibernate.Session session) Called after parser completes parsing all child nodes in list's element node.
protected VariableSubstitution	createItemInstance(org.codehaus.staxmate.in.SMInputCursor inputCursor) Creates empty instance of the imported object
void	exportData(org.codehaus.staxmate.out.SMOutputElement outputElement) Perform data export
protected void	exportProperties(org.codehaus.staxmate.out.SMOutputElement outputElement, VariableSubstitution object, net.sf.hibernate.Session session) Export object properties.
java.lang.String	getXmlElementNodeName()
java.lang.String	getXmlRootNodeName() Returns local name of the XML parent node handled by this mapper
void	importData(org.codehaus.staxmate.in.SMInputCursor inputCursor) Perform data import
protected void	importProperties(VariableSubstitution object, org.codehaus.staxmate.in.SMInputCursor inputCursor, net.sf.hibernate.Session session) Import properties to the object.

Methods inherited from class com.atlassian.bamboo.migration.BambooStAXMappingListHelperAbstractImpl

beforeImportListItem, createListRootElement, createRootElement, eventEndElementOfListItemSaveObject, exportListXml, exportListXml, flushIfNeeded, importListXml, importListXml, setListImportStrategy

Methods inherited from class com.atlassian.bamboo.migration.BambooStAXMappingHelperAbstractImpl

commitClearSession, commitSession, exportXml, exportXml, getSession, getSessionFactory, importXml, importXml, saveBambooObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.bamboo.migration.BambooStAXMappingHelper

exportXml, importXml

Constructor Detail

VariableSubstitutionMapper

public VariableSubstitutionMapper(net.sf.hibernate.SessionFactory sessionFactory,
                                  @NotNull
                                  BuildResultsSummaryDao buildResultsSummaryDao)

Method Detail

afterImportListItem

public void afterImportListItem(@NotNull
                                org.codehaus.staxmate.in.SMInputCursor cursor,
                                @NotNull
                                java.util.List<VariableSubstitution> list,
                                @NotNull
                                VariableSubstitution object,
                                long objectIndex,
                                @NotNull
                                net.sf.hibernate.Session session)
                         throws java.lang.Exception

Description copied from class: BambooStAXMappingListHelperAbstractImpl

Called after parser completes parsing all child nodes in list's element node.

Overrides:

afterImportListItem in class BambooStAXMappingListHelperAbstractImpl<VariableSubstitution>

Parameters:

cursor - cursor pointing to the list's element opening node

list - list of elements being imported

object - object that has been imported

objectIndex - one-based index of the object being parsed

session - Hibernate session object

Throws:

java.lang.Exception - when something went wrong

createItemInstance

@NotNull
protected VariableSubstitution createItemInstance(org.codehaus.staxmate.in.SMInputCursor inputCursor)
                                           throws java.lang.Exception

Description copied from class: BambooStAXMappingHelperAbstractImpl

Creates empty instance of the imported object

Specified by:

createItemInstance in class BambooStAXMappingHelperAbstractImpl<VariableSubstitution>

Parameters:

inputCursor - input cursor that points to the parent node containing object properties

Returns:

empty instance of the imported object

Throws:

javax.xml.stream.XMLStreamException - when something went wrong

java.lang.Exception

getXmlElementNodeName

@NotNull
public java.lang.String getXmlElementNodeName()

getXmlRootNodeName

@NotNull
public java.lang.String getXmlRootNodeName()

Description copied from interface: BambooStAXRootMapper

Returns local name of the XML parent node handled by this mapper

Specified by:

getXmlRootNodeName in interface BambooStAXMappingHelper<VariableSubstitution>

Specified by:

getXmlRootNodeName in interface BambooStAXRootMapper

Returns:

local name of the XML parent node

exportProperties

protected void exportProperties(@NotNull
                                org.codehaus.staxmate.out.SMOutputElement outputElement,
                                @NotNull
                                VariableSubstitution object,
                                @NotNull
                                net.sf.hibernate.Session session)
                         throws java.lang.Exception

Description copied from class: BambooStAXMappingHelperAbstractImpl

Export object properties. Implementing classed should override this method to export custom properties.

Overrides:

exportProperties in class BambooStAXMappingHelperAbstractImpl<VariableSubstitution>

Parameters:

outputElement - the parent node

object - object being exported

session - Hibernate session object

Throws:

java.lang.Exception - when something went wrong

exportData

public void exportData(@NotNull
                       org.codehaus.staxmate.out.SMOutputElement outputElement)
                throws java.lang.Exception

Description copied from interface: BambooStAXRootMapper

Perform data export

Specified by:

exportData in interface BambooStAXRootMapper

Parameters:

outputElement - parent node for mapper's root node, usually root element of the XML file

Throws:

java.lang.Exception - when something went wrong

importProperties

protected void importProperties(@NotNull
                                VariableSubstitution object,
                                @NotNull
                                org.codehaus.staxmate.in.SMInputCursor inputCursor,
                                @NotNull
                                net.sf.hibernate.Session session)
                         throws java.lang.Exception

Description copied from class: BambooStAXMappingHelperAbstractImpl

Import properties to the object. Due to nature of XML parsing this method is called for each child node in the node that was passed to importXml method

Overrides:

importProperties in class BambooStAXMappingHelperAbstractImpl<VariableSubstitution>

Parameters:

object - object being imported

inputCursor - input cursor pointing to the child node of node that was passed to importXml method

session - Hibernate session object

Throws:

java.lang.Exception - when something went wrong

importData

public void importData(@NotNull
                       org.codehaus.staxmate.in.SMInputCursor inputCursor)
                throws java.lang.Exception

Description copied from interface: BambooStAXRootMapper

Perform data import

Specified by:

importData in interface BambooStAXRootMapper

Parameters:

inputCursor - mapper's root node, usually child of root element of the XML file

Throws:

java.lang.Exception - when something went wrong