de.hybris.platform.bmecat.xmlwriter

Class XMLTagWriter

java.lang.Object

de.hybris.platform.bmecat.xmlwriter.XMLTagWriter

Direct Known Subclasses:

AddressTagWriter, AgreementTagWriter, ArticleDetailsTagWriter, ArticleFeaturesTagWriter, ArticleOrderDetailsTagWriter, ArticlePriceDetailsTagWriter, ArticlePriceTagWriter, ArticleReferenceTagWriter, ArticleTagWriter, ArticleToCatalogGroupMapTagWriter, BMECatTagWriter, CatalogGroupSystemTagWriter, CatalogStructureTagWriter, CatalogTagWriter, ClassificationAttributeValueTagWriter, CompanyTagWriter, DateTimeTagWriter, FeatureTagWriter, HeaderTagWriter, MimeInfoTagWriter, MimeTagWriter, SimpleTagWriter, SpecialTreatmentClassTagWriter, TNewCatalogTagWriter, UserDefinedExtensionsTagWriter, VariantsTagWriter, VariantTagWriter

Deprecated.

replaced by XMLTagWriter

@Deprecated
public abstract class XMLTagWriter
extends Object

Super class of all XMLTagWriter.

Constructor Summary

Constructors

Constructor and Description
XMLTagWriter(XMLTagWriter parent) Deprecated. Constructs an instance of XMLTagWriter.
XMLTagWriter(XMLTagWriter parent, boolean mandatory) Deprecated. Constructs an instance of XMLTagWriter.

Method Summary

Modifier and Type	Method and Description
void	addSubTagWriter(String tagName, Map typeMap) Deprecated. Here you can add or replace an sub-XMLTagWriter to this XMLTagWriter.
void	addSubTagWriter(XMLTagWriter tagWriter) Deprecated. Here you can add or replace an sub-XMLTagWriter to this XMLTagWriter.
void	addSubTagWriter(XMLTagWriter tagWriter, String type) Deprecated. Here you can add or replace an sub-XMLTagWriter to this XMLTagWriter.
protected void	debug(String message) Deprecated.
protected void	error(String message) Deprecated.
Collection	getAllSubTagWriter() Deprecated. Returns all tagwriter of this XMLTagWriter
protected Map	getAttributesMap(Object object) Deprecated. Overwrite this method, if you want to specify attributes at the actual tag.
protected XMLTagWriter	getParent() Deprecated. Returns the parent of this XMLTagWriter
XMLTagWriter	getSubTagWriter(String tagName) Deprecated. Returns the XMLTagWriter with the given tagName
XMLTagWriter	getSubTagWriter(String tagName, String type) Deprecated. Returns the XMLTagWriter with the given tagName
protected abstract String	getTagName() Deprecated. Returns the name of the xml tag.
protected void	info(String message) Deprecated.
protected boolean	isDebugEnabled() Deprecated.
protected boolean	isErrorEnabled() Deprecated.
protected boolean	isInfoEnabled() Deprecated.
boolean	isMandatory() Deprecated.
protected boolean	isWarnEnabled() Deprecated.
protected void	warn(String message) Deprecated.
void	write(XMLOutputter xmlOut, Object object) Deprecated. This method write the start- and endtag of your tag.
protected abstract void	writeContent(XMLOutputter xmlOut, Object object) Deprecated. Here you can write out the data to the given XMLOutputter.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLTagWriter

public XMLTagWriter(XMLTagWriter parent)

Deprecated.

Constructs an instance of XMLTagWriter.

Parameters:

parent - the parent XMLTagWriter of this instance

XMLTagWriter

public XMLTagWriter(XMLTagWriter parent,
                    boolean mandatory)

Deprecated.

Constructs an instance of XMLTagWriter.

Parameters:

parent - the parent XMLTagWriter of this instance

mandatory - true if this is a mandatory tag, false otherwise

Method Detail

isInfoEnabled

protected boolean isInfoEnabled()

Deprecated.

isDebugEnabled

protected boolean isDebugEnabled()

Deprecated.

isWarnEnabled

protected boolean isWarnEnabled()

Deprecated.

isErrorEnabled

protected boolean isErrorEnabled()

Deprecated.

info

protected void info(String message)

Deprecated.

debug

protected void debug(String message)

Deprecated.

warn

protected void warn(String message)

Deprecated.

error

protected void error(String message)

Deprecated.

getTagName

protected abstract String getTagName()

Deprecated.

Returns the name of the xml tag.

Returns:

the name of the tag

writeContent

protected abstract void writeContent(XMLOutputter xmlOut,
                                     Object object)
                              throws IOException

Deprecated.

Here you can write out the data to the given XMLOutputter. This method will write the content between the start- and endtag.

Parameters:

xmlOut - the XMLOutputter to write to

object - the data object, it depends on the parent what kind of object you get here

Throws:

IOException

getAttributesMap

protected Map getAttributesMap(Object object)

Deprecated.

Overwrite this method, if you want to specify attributes at the actual tag. The name of the attribute has to be the key of the Map.

Parameters:

object - the data object, it depends on the parent what kind of object you get here

Returns:

the attributes Map

write

public final void write(XMLOutputter xmlOut,
                        Object object)

Deprecated.

This method write the start- and endtag of your tag. It also calls the method writeContent to write the data between these two tags.

Parameters:

xmlOut - the XMLOutputter to write to

object - the data object, it depends on the parent what kind of object you get here

getParent

protected XMLTagWriter getParent()

Deprecated.

Returns the parent of this XMLTagWriter

Returns:

the parent XMLTagWriter or null if no parent was declared

addSubTagWriter

public void addSubTagWriter(XMLTagWriter tagWriter)

Deprecated.

Here you can add or replace an sub-XMLTagWriter to this XMLTagWriter.

Parameters:

tagWriter - the new XMLTagWriter

addSubTagWriter

public void addSubTagWriter(XMLTagWriter tagWriter,
                            String type)

Deprecated.

Here you can add or replace an sub-XMLTagWriter to this XMLTagWriter. If you have more than one subtagwriter with the same tagname, than you have to specify a type for the tagwriter, so you can indentify it in the getSubTagWriter-method.

Parameters:

tagWriter - tagWriter the new XMLTagWriter

type - the type of this XMLTagWriter

addSubTagWriter

public void addSubTagWriter(String tagName,
                            Map typeMap)

Deprecated.

Here you can add or replace an sub-XMLTagWriter to this XMLTagWriter. If you have more than one subtagwriter with the same tagname, than you have to specify a type for the tagwriter, so you can indentify it in the getSubTagWriter-method.

Parameters:

tagName - name of the tag

typeMap - key of the Map is a type (String) and value is a XMLTagWriter

getAllSubTagWriter

public Collection getAllSubTagWriter()

Deprecated.

Returns all tagwriter of this XMLTagWriter

Returns:

all tagwriter of this XMLTagWriter

getSubTagWriter

public XMLTagWriter getSubTagWriter(String tagName)

Deprecated.

Returns the XMLTagWriter with the given tagName

Parameters:

tagName - name of the tag

Returns:

the XMLTagWriter with the given tagName

Throws:

IllegalArgumentException - if no XMLTagWriter was found for the given tag name

getSubTagWriter

public XMLTagWriter getSubTagWriter(String tagName,
                                    String type)

Deprecated.

Returns the XMLTagWriter with the given tagName

Parameters:

tagName - name of the tag

type - type of the XMLTagWriter

Returns:

the XMLTagWriter with the given tagName

Throws:

IllegalArgumentException - if no XMLTagWriter was found for the given tag name and type

isMandatory

public boolean isMandatory()

Deprecated.

Returns:

Returns the mandatory.