Package org.apache.ivy.plugins.parser.xml

Class XmlModuleDescriptorUpdater.UpdaterHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.apache.ivy.plugins.parser.xml.XmlModuleDescriptorUpdater.UpdaterHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler, LexicalHandler

Enclosing class:

XmlModuleDescriptorUpdater

private static class XmlModuleDescriptorUpdater.UpdaterHandler
extends DefaultHandler
implements LexicalHandler

Field Summary

Fields

Modifier and Type	Field	Description
private Stack<XmlModuleDescriptorUpdater.ExtendedBuffer>	buffers
private Stack<XmlModuleDescriptorUpdater.ExtendedBuffer>	confAttributeBuffers
private static final int	CONFIGURATIONS_POSITION	element position of "configurations" inside "ivy-module"
private Boolean	confMappingOverride
private final List<String>	confs
private Stack<String>	context
private StringBuilder	currentIndent
private String	defaultConf
private String	defaultConfMapping
private static final int	DEPENDENCIES_POSITION	element position of "dependencies" inside "ivy-module"
private final boolean	generateRevConstraint
private boolean	hasDescription
private boolean	indenting
private List<String>	indentLevels
private static final Collection<String>	INFO_ELEMENTS	elements that may appear inside of ivy-module/info
private boolean	inHeader
private String	justOpen
private boolean	mergedConfigurations
private boolean	mergedDependencies
private static final List<String>	MODULE_ELEMENTS	elements that may appear inside ivy-module, in expected order
private String	newDefaultConf
private final Namespace	ns
private final UpdateOptions	options
private String	organisation
private final PrintWriter	out
private final Date	pubdate
private final URL	relativePathCtx
private final boolean	replaceInclude
private final Map<ModuleRevisionId,String>	resolvedBranches
private final Map<ModuleRevisionId,String>	resolvedRevisions
private final String	revision
private final ParserSettings	settings
private final String	status
private static final Collection<String>	STD_ATTS	standard attributes of ivy-module/info

Constructor Summary

Constructors

Constructor	Description
UpdaterHandler(URL relativePathCtx, PrintWriter out, UpdateOptions options)

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)
private Map<ModuleRevisionId,List<InheritableItem>>	collateInheritedItems(ModuleDescriptor merged, InheritableItem[] items)	Collect the given list of inherited descriptor items into lists keyed by parent Id.
void	comment(char[] ch, int start, int length)
void	endCDATA()
void	endDocument()
void	endDTD()
void	endElement(String uri, String localName, String qName)
void	endEntity(String name)
private void	endIndent()	record the current indent level for future elements that appear at the same depth
void	error(SAXParseException e)
void	fatalError(SAXParseException e)
private void	fillIndents(int level)	Guarantee that indent levels have been calculated up to and including the given depth (starting at 0).
private void	flushAllMergedElements()
private void	flushMergedElementsBefore(String moduleElement)	If publishing in merge mode, guarantee that any merged elements appearing before moduleElement have been written.
private String	getContext()
private String	getIndent()	get the whitespace that should precede new elements at the current depth in the document
private PrintWriter	getWriter()
void	ignorableWhitespace(char[] ch, int start, int length)
private void	includeStarted(Attributes attributes)
private void	infoStarted(Attributes attributes)
void	processingInstruction(String target, String data)
private String	removeConfigurationsFromList(String list)
private String	removeConfigurationsFromMapping(String mapping)
private void	setIndent(int level, String indent)	Set the indent for the given depth.
void	startCDATA()
void	startDTD(String name, String publicId, String systemId)
void	startElement(String uri, String localName, String qName, Attributes attributes)
private void	startElementInConfigurationsConf(String qName, Attributes attributes)
private void	startElementInDependency(Attributes attributes)
private void	startElementWithConfAttributes(String qName, Attributes attributes)
void	startEntity(String name)
private void	startExtends(Attributes attributes)
private void	startPublications(Attributes attributes)
private String	substitute(ParserSettings ivy, String value)
void	warning(SAXParseException e)
private void	write(String content)
private void	writeInheritanceComment(String itemDescription, Object parentInfo)
private void	writeInheritedConfigurations(ModuleDescriptor merged)
private void	writeInheritedDependencies(ModuleDescriptor merged)
private void	writeInheritedDescription(ModuleDescriptor merged)	If no info/description element has yet been written, write the description inherited from the parent descriptor, if any.
private void	writeInheritedItems(ModuleDescriptor merged, InheritableItem[] items, XmlModuleDescriptorUpdater.ItemPrinter printer, String itemName, boolean includeContainer)	Write XML elements that do not appear in the source descriptor, but have been copied in from a parent module descriptor via <extends> declaration.

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endPrefixMapping, notationDecl, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Field Details

STD_ATTS

private static final Collection<String> STD_ATTS

standard attributes of ivy-module/info

MODULE_ELEMENTS

private static final List<String> MODULE_ELEMENTS

elements that may appear inside ivy-module, in expected order

CONFIGURATIONS_POSITION

private static final int CONFIGURATIONS_POSITION

element position of "configurations" inside "ivy-module"

DEPENDENCIES_POSITION

private static final int DEPENDENCIES_POSITION

element position of "dependencies" inside "ivy-module"

INFO_ELEMENTS

private static final Collection<String> INFO_ELEMENTS

elements that may appear inside of ivy-module/info

settings

private final ParserSettings settings

out

private final PrintWriter out

resolvedRevisions

private final Map<ModuleRevisionId,String> resolvedRevisions

resolvedBranches

private final Map<ModuleRevisionId,String> resolvedBranches

status

private final String status

revision

private final String revision

pubdate

private final Date pubdate

ns

private final Namespace ns

replaceInclude

private final boolean replaceInclude

generateRevConstraint

private final boolean generateRevConstraint

inHeader

private boolean inHeader

confs

private final List<String> confs

relativePathCtx

private final URL relativePathCtx

options

private final UpdateOptions options

organisation

private String organisation

defaultConf

private String defaultConf

defaultConfMapping

private String defaultConfMapping

confMappingOverride

private Boolean confMappingOverride

justOpen

private String justOpen

indenting

private boolean indenting

currentIndent

private StringBuilder currentIndent

indentLevels

private List<String> indentLevels

hasDescription

private boolean hasDescription

mergedConfigurations

private boolean mergedConfigurations

mergedDependencies

private boolean mergedDependencies

newDefaultConf

private String newDefaultConf

context

private Stack<String> context

buffers

private Stack<XmlModuleDescriptorUpdater.ExtendedBuffer> buffers

confAttributeBuffers

private Stack<XmlModuleDescriptorUpdater.ExtendedBuffer> confAttributeBuffers

Constructor Details

UpdaterHandler

public UpdaterHandler(URL relativePathCtx,
 PrintWriter out,
 UpdateOptions options)

Method Details

startElement

public void startElement(String uri,
 String localName,
 String qName,
 Attributes attributes)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

startExtends

private void startExtends(Attributes attributes)

startElementInConfigurationsConf

private void startElementInConfigurationsConf(String qName,
 Attributes attributes)

startElementWithConfAttributes

private void startElementWithConfAttributes(String qName,
 Attributes attributes)

startPublications

private void startPublications(Attributes attributes)

startElementInDependency

private void startElementInDependency(Attributes attributes)

includeStarted

private void includeStarted(Attributes attributes)
                     throws SAXException

Throws:

SAXException

infoStarted

private void infoStarted(Attributes attributes)

write

private void write(String content)

getWriter

private PrintWriter getWriter()

getContext

private String getContext()

substitute

private String substitute(ParserSettings ivy,
 String value)

removeConfigurationsFromMapping

private String removeConfigurationsFromMapping(String mapping)

removeConfigurationsFromList

private String removeConfigurationsFromList(String list)

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
 int start,
 int length)
                         throws SAXException

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class DefaultHandler

Throws:

SAXException

characters

public void characters(char[] ch,
 int start,
 int length)
                throws SAXException

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

endIndent

private void endIndent()

record the current indent level for future elements that appear at the same depth

setIndent

private void setIndent(int level,
 String indent)

Set the indent for the given depth. Indents less than the provided depth will be calculated automatically, if they have not already been defined.

fillIndents

private void fillIndents(int level)

Guarantee that indent levels have been calculated up to and including the given depth (starting at 0).

getIndent

private String getIndent()

get the whitespace that should precede new elements at the current depth in the document

writeInheritedItems

private void writeInheritedItems(ModuleDescriptor merged,
 InheritableItem[] items,
 XmlModuleDescriptorUpdater.ItemPrinter printer,
 String itemName,
 boolean includeContainer)

Write XML elements that do not appear in the source descriptor, but have been copied in from a parent module descriptor via <extends> declaration.

Parameters:

merged - child descriptor containing the merged data

items - the list of inherited items to print

printer - a printer that knows how to write the given type of item

itemName - the name of the container element, e.g. "configurations"

includeContainer - if true, include an enclosing element named itemName. Otherwise just write the inherited items inline, with a comment indicating where they came from.

writeInheritanceComment

private void writeInheritanceComment(String itemDescription,
 Object parentInfo)

collateInheritedItems

private Map<ModuleRevisionId,List<InheritableItem>> collateInheritedItems(ModuleDescriptor merged,
 InheritableItem[] items)

Collect the given list of inherited descriptor items into lists keyed by parent Id. Thus all of the items inherited from parent A can be written together, then all of the items from parent B, and so on.

Parameters:

merged - the merged child descriptor

items - the inherited items to collate

Returns:

maps parent ModuleRevisionId to a List of InheritedItems imported from that parent

writeInheritedDescription

private void writeInheritedDescription(ModuleDescriptor merged)

If no info/description element has yet been written, write the description inherited from the parent descriptor, if any. Calling this method more than once has no affect.

writeInheritedConfigurations

private void writeInheritedConfigurations(ModuleDescriptor merged)

writeInheritedDependencies

private void writeInheritedDependencies(ModuleDescriptor merged)

flushMergedElementsBefore

private void flushMergedElementsBefore(String moduleElement)

If publishing in merge mode, guarantee that any merged elements appearing before moduleElement have been written. This method should be called before we write the start tag of moduleElement. This covers cases where merged elements like "configurations" and "dependencies" appear in the parent descriptor, but are completely missing in the child descriptor.

For example, if "moduleElement" is "dependencies", guarantees that "configurations" has been written. If moduleElement is null, then all missing merged elements will be flushed.

Parameters:

moduleElement - a descriptor element name, for example "configurations" or "info"

flushAllMergedElements

private void flushAllMergedElements()

endElement

public void endElement(String uri,
 String localName,
 String qName)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class DefaultHandler

Throws:

SAXException

processingInstruction

public void processingInstruction(String target,
 String data)
                           throws SAXException

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class DefaultHandler

Throws:

SAXException

warning

public void warning(SAXParseException e)
             throws SAXException

Specified by:

warning in interface ErrorHandler

Overrides:

warning in class DefaultHandler

Throws:

SAXException

error

public void error(SAXParseException e)
           throws SAXException

Specified by:

error in interface ErrorHandler

Overrides:

error in class DefaultHandler

Throws:

SAXException

fatalError

public void fatalError(SAXParseException e)
                throws SAXException

Specified by:

fatalError in interface ErrorHandler

Overrides:

fatalError in class DefaultHandler

Throws:

SAXException

endCDATA

public void endCDATA()
              throws SAXException

Specified by:

endCDATA in interface LexicalHandler

Throws:

SAXException

endDTD

public void endDTD()
            throws SAXException

Specified by:

endDTD in interface LexicalHandler

Throws:

SAXException

startCDATA

public void startCDATA()
                throws SAXException

Specified by:

startCDATA in interface LexicalHandler

Throws:

SAXException

comment

public void comment(char[] ch,
 int start,
 int length)
             throws SAXException

Specified by:

comment in interface LexicalHandler

Throws:

SAXException

endEntity

public void endEntity(String name)
               throws SAXException

Specified by:

endEntity in interface LexicalHandler

Throws:

SAXException

startEntity

public void startEntity(String name)
                 throws SAXException

Specified by:

startEntity in interface LexicalHandler

Throws:

SAXException

startDTD

public void startDTD(String name,
 String publicId,
 String systemId)
              throws SAXException

Specified by:

startDTD in interface LexicalHandler

Throws:

SAXException