org.codehaus.plexus.metadata.merge.support

Class AbstractMergeableSupport

java.lang.Object

org.codehaus.plexus.metadata.merge.support.AbstractMergeableSupport

All Implemented Interfaces:

Mergeable

Direct Known Subclasses:

AbstractMergeableElement

public abstract class AbstractMergeableSupport
extends java.lang.Object
implements Mergeable

Field Summary

Fields

Modifier and Type	Field and Description
private static MergeStrategy	DEFAULT_MERGE_STRATEGY The default merging strategy used.
protected org.jdom2.Element	element Wrapped JDOM element.

Constructor Summary

Constructors

Constructor and Description
AbstractMergeableSupport(org.jdom2.Element element)

Method Summary

Modifier and Type	Method and Description
org.jdom2.Element	addContent(java.util.Collection collection)
org.jdom2.Element	addContent(org.jdom2.Content child)
org.jdom2.Element	addContent(int index, java.util.Collection c)
org.jdom2.Element	addContent(int index, org.jdom2.Content child)
org.jdom2.Element	addContent(java.lang.String str)
void	addNamespaceDeclaration(org.jdom2.Namespace additional)
java.lang.Object	clone()
java.util.List	cloneContent()
org.jdom2.Content	detach()
boolean	equals(java.lang.Object obj)
java.util.List	getAdditionalNamespaces()
org.jdom2.Attribute	getAttribute(java.lang.String name)
org.jdom2.Attribute	getAttribute(java.lang.String name, org.jdom2.Namespace ns)
java.util.List	getAttributes()
java.lang.String	getAttributeValue(java.lang.String name)
java.lang.String	getAttributeValue(java.lang.String name, org.jdom2.Namespace ns)
java.lang.String	getAttributeValue(java.lang.String name, org.jdom2.Namespace ns, java.lang.String def)
java.lang.String	getAttributeValue(java.lang.String name, java.lang.String def)
org.jdom2.Element	getChild(java.lang.String name)
org.jdom2.Element	getChild(java.lang.String name, org.jdom2.Namespace ns)
java.util.List	getChildren()
java.util.List	getChildren(java.lang.String name)
java.util.List	getChildren(java.lang.String name, org.jdom2.Namespace ns)
java.lang.String	getChildText(java.lang.String name)
java.lang.String	getChildText(java.lang.String name, org.jdom2.Namespace ns)
java.lang.String	getChildTextNormalize(java.lang.String name)
java.lang.String	getChildTextNormalize(java.lang.String name, org.jdom2.Namespace ns)
java.lang.String	getChildTextTrim(java.lang.String name)
java.lang.String	getChildTextTrim(java.lang.String name, org.jdom2.Namespace ns)
java.util.List	getContent()
java.util.List	getContent(org.jdom2.filter.Filter filter)
org.jdom2.Content	getContent(int index)
int	getContentSize()
protected MergeStrategy	getDefaultMergeStrategy() Returns the default MergeStrategy instance.
java.util.Iterator	getDescendants()
java.util.Iterator	getDescendants(org.jdom2.filter.Filter filter)
org.jdom2.Document	getDocument()
org.jdom2.Element	getElement() Returns the wrapped up JDom Element instance.
protected java.util.List	getElementNamesForConflictResolution(java.util.List defaultList) Sub classes should override if they wish to provide a different combination of composite keys for determining conflicts.
java.lang.String	getName()
org.jdom2.Namespace	getNamespace()
org.jdom2.Namespace	getNamespace(java.lang.String prefix)
java.lang.String	getNamespacePrefix()
java.lang.String	getNamespaceURI()
org.jdom2.Parent	getParent()
org.jdom2.Element	getParentElement()
java.lang.String	getQualifiedName()
java.lang.String	getText()
java.lang.String	getTextNormalize()
java.lang.String	getTextTrim()
java.lang.String	getValue()
int	hashCode()
int	indexOf(org.jdom2.Content child)
boolean	isAncestor(org.jdom2.Element element)
protected abstract boolean	isExpectedElementType(Mergeable me) Determines if the passed in Mergeable was of same type as this class.
boolean	isRootElement()
abstract void	merge(Mergeable me) Merges an element of same type.
boolean	removeAttribute(org.jdom2.Attribute attribute)
boolean	removeAttribute(java.lang.String name)
boolean	removeAttribute(java.lang.String name, org.jdom2.Namespace ns)
boolean	removeChild(java.lang.String name)
boolean	removeChild(java.lang.String name, org.jdom2.Namespace ns)
boolean	removeChildren(java.lang.String name)
boolean	removeChildren(java.lang.String name, org.jdom2.Namespace ns)
java.util.List	removeContent()
boolean	removeContent(org.jdom2.Content child)
java.util.List	removeContent(org.jdom2.filter.Filter filter)
org.jdom2.Content	removeContent(int index)
void	removeNamespaceDeclaration(org.jdom2.Namespace additionalNamespace)
org.jdom2.Element	setAttribute(org.jdom2.Attribute attribute)
org.jdom2.Element	setAttribute(java.lang.String name, java.lang.String value)
org.jdom2.Element	setAttribute(java.lang.String name, java.lang.String value, org.jdom2.Namespace ns)
org.jdom2.Element	setAttributes(java.util.List newAttributes)
org.jdom2.Element	setContent(java.util.Collection newContent)
org.jdom2.Element	setContent(org.jdom2.Content child)
org.jdom2.Parent	setContent(int index, java.util.Collection collection)
org.jdom2.Element	setContent(int index, org.jdom2.Content child)
org.jdom2.Element	setName(java.lang.String name)
org.jdom2.Element	setNamespace(org.jdom2.Namespace namespace)
org.jdom2.Element	setText(java.lang.String text)
java.lang.String	toString() Element.toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.codehaus.plexus.metadata.merge.support.Mergeable

getAllowedTags, merge

Field Detail

element

protected org.jdom2.Element element

Wrapped JDOM element.

DEFAULT_MERGE_STRATEGY

private static final MergeStrategy DEFAULT_MERGE_STRATEGY

The default merging strategy used.

Constructor Detail

AbstractMergeableSupport

public AbstractMergeableSupport(org.jdom2.Element element)

Parameters:

element - Element

Method Detail

merge

public abstract void merge(Mergeable me)
                    throws MergeException

Merges an element of same type.

Specified by:

merge in interface Mergeable

Parameters:

me - Another entity that is mergeable.

Throws:

MergeException - if there was an error merging the mergeables.

isExpectedElementType

protected abstract boolean isExpectedElementType(Mergeable me)

Determines if the passed in Mergeable was of same type as this class.

Parameters:

me - Mergeable instance to test.

Returns:

true if the passed in Mergeable can be merged with the current Mergeable.

addContent

public org.jdom2.Element addContent(java.util.Collection collection)

Parameters:

collection - Collection

Returns:

Element.

addContent

public org.jdom2.Element addContent(org.jdom2.Content child)

Parameters:

child - Content

Returns:

Element.

addContent

public org.jdom2.Element addContent(int index,
                                    java.util.Collection c)

Parameters:

index - The index.

c - Collection

Returns:

Element.

addContent

public org.jdom2.Element addContent(int index,
                                    org.jdom2.Content child)

Parameters:

index - The index.

child - Content

Returns:

Element.

addContent

public org.jdom2.Element addContent(java.lang.String str)

Parameters:

str - The content to be added.

Returns:

Element.

addNamespaceDeclaration

public void addNamespaceDeclaration(org.jdom2.Namespace additional)

Parameters:

additional - Namespace

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

cloneContent

public java.util.List cloneContent()

detach

public org.jdom2.Content detach()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getAdditionalNamespaces

public java.util.List getAdditionalNamespaces()

Returns:

list of Namespaces.

getAttribute

public org.jdom2.Attribute getAttribute(java.lang.String name,
                                        org.jdom2.Namespace ns)

Parameters:

name - The name.

ns - Namespace

Returns:

Attribute

getAttribute

public org.jdom2.Attribute getAttribute(java.lang.String name)

Parameters:

name - The name of the attribute.

Returns:

Attribute

getAttributes

public java.util.List getAttributes()

Returns:

list Attribute

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String name,
                                          org.jdom2.Namespace ns,
                                          java.lang.String def)

Parameters:

name - The name of the attribute.

ns - The Namespace

def - the default value.

Returns:

The value of the attribute.

See Also:

Element.getAttributeValue(java.lang.String,org.jdom2.Namespace,java.lang.String)

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String name,
                                          org.jdom2.Namespace ns)

Parameters:

name - The name of the attribute.

ns - The Namespace

Returns:

The value of the attribute.

See Also:

Element.getAttributeValue(java.lang.String,org.jdom2.Namespace)

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String name,
                                          java.lang.String def)

Parameters:

name - The name of the attribute.

def - the default value.

Returns:

The value of the attribute.

See Also:

Element.getAttributeValue(java.lang.String,java.lang.String)

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String name)

Parameters:

name - The name of the attribute.

Returns:

The value of the attribute.

See Also:

Element.getAttributeValue(java.lang.String)

getChild

public org.jdom2.Element getChild(java.lang.String name,
                                  org.jdom2.Namespace ns)

Parameters:

name - The name of the child.

ns - Namespace

Returns:

Element

See Also:

Element.getChild(java.lang.String,org.jdom2.Namespace)

getChild

public org.jdom2.Element getChild(java.lang.String name)

Parameters:

name - The name of the child.

Returns:

Element

See Also:

Element.getChild(java.lang.String)

getChildren

public java.util.List getChildren()

Returns:

list of Element

See Also:

Element.getChildren()

getChildren

public java.util.List getChildren(java.lang.String name,
                                  org.jdom2.Namespace ns)

Parameters:

name - The name of the child.

ns - Namespace

Returns:

list Element

See Also:

Element.getChildren(java.lang.String,org.jdom2.Namespace)

getChildren

public java.util.List getChildren(java.lang.String name)

Parameters:

name - The name.

Returns:

list Element

See Also:

Element.getChildren(java.lang.String)

getChildText

public java.lang.String getChildText(java.lang.String name,
                                     org.jdom2.Namespace ns)

Parameters:

name - The name of the child.

ns - Namespace

Returns:

the child text.

See Also:

Element.getChildText(java.lang.String,org.jdom2.Namespace)

getChildText

public java.lang.String getChildText(java.lang.String name)

Parameters:

name - The name of the child.

Returns:

the child text.

See Also:

Element.getChildText(java.lang.String)

getChildTextNormalize

public java.lang.String getChildTextNormalize(java.lang.String name,
                                              org.jdom2.Namespace ns)

Parameters:

name - The name of the child.

ns - Namespace

Returns:

the child text.

See Also:

Element.getChildTextNormalize(java.lang.String,org.jdom2.Namespace)

getChildTextNormalize

public java.lang.String getChildTextNormalize(java.lang.String name)

Parameters:

name - The name of the child.

Returns:

the child text.

See Also:

Element.getChildTextNormalize(java.lang.String)

getChildTextTrim

public java.lang.String getChildTextTrim(java.lang.String name,
                                         org.jdom2.Namespace ns)

Parameters:

name - The name of the child.

ns - Namespace

Returns:

the child text.

See Also:

Element.getChildTextTrim(java.lang.String,org.jdom2.Namespace)

getChildTextTrim

public java.lang.String getChildTextTrim(java.lang.String name)

Parameters:

name - The name of the child.

Returns:

the child text.

See Also:

Element.getChildTextTrim(java.lang.String)

getContent

public java.util.List getContent()

Returns:

list of content.

See Also:

Element.getContent()

getContent

public java.util.List getContent(org.jdom2.filter.Filter filter)

Parameters:

filter - Filter

Returns:

list of content.

See Also:

Element.getContent(org.jdom2.filter.Filter)

getContent

public org.jdom2.Content getContent(int index)

Parameters:

index - The index.

Returns:

the content.

See Also:

Element.getContent(int)

getContentSize

public int getContentSize()

Returns:

The content size.

See Also:

Element.getContentSize()

getDescendants

public java.util.Iterator getDescendants()

Returns:

Iterator of descendants.

See Also:

Element.getDescendants()

getDescendants

public java.util.Iterator getDescendants(org.jdom2.filter.Filter filter)

Parameters:

filter - Filter

Returns:

Iterator of descendants.

See Also:

Element.getDescendants(org.jdom2.filter.Filter)

getDocument

public org.jdom2.Document getDocument()

Returns:

the document.

See Also:

Content.getDocument()

getName

public java.lang.String getName()

Returns:

The name of the element.

See Also:

Element.getName()

getNamespace

public org.jdom2.Namespace getNamespace()

Returns:

Namespace

See Also:

Element.getNamespace()

getNamespace

public org.jdom2.Namespace getNamespace(java.lang.String prefix)

Parameters:

prefix - The prefix.

Returns:

Namespace

See Also:

Element.getNamespace(java.lang.String)

getNamespacePrefix

public java.lang.String getNamespacePrefix()

Returns:

the namespace prefix.

See Also:

Element.getNamespacePrefix()

getNamespaceURI

public java.lang.String getNamespaceURI()

Returns:

the namespace URI.

See Also:

Element.getNamespaceURI()

getParent

public org.jdom2.Parent getParent()

Returns:

The parent.

See Also:

Content.getParent()

getParentElement

public org.jdom2.Element getParentElement()

Returns:

the parent Element

See Also:

Content.getParentElement()

getQualifiedName

public java.lang.String getQualifiedName()

Returns:

The qualified name.

See Also:

Element.getQualifiedName()

getText

public java.lang.String getText()

Returns:

The text.

See Also:

Element.getText()

getTextNormalize

public java.lang.String getTextNormalize()

Returns:

the normalized text.

See Also:

Element.getTextNormalize()

getTextTrim

public java.lang.String getTextTrim()

Returns:

the trimmed text.

See Also:

Element.getTextTrim()

getValue

public java.lang.String getValue()

Returns:

the element value.

See Also:

Element.getValue()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

indexOf

public int indexOf(org.jdom2.Content child)

Parameters:

child - The child.

Returns:

the index.

See Also:

Element.indexOf(org.jdom2.Content)

isAncestor

public boolean isAncestor(org.jdom2.Element element)

Parameters:

element - Element.

Returns:

true/false.

See Also:

Element.isAncestor(org.jdom2.Element)

isRootElement

public boolean isRootElement()

Returns:

true/false.

See Also:

Element.isRootElement()

removeAttribute

public boolean removeAttribute(org.jdom2.Attribute attribute)

Parameters:

attribute - Attribute

Returns:

true/false.

See Also:

Element.removeAttribute(org.jdom2.Attribute)

removeAttribute

public boolean removeAttribute(java.lang.String name,
                               org.jdom2.Namespace ns)

Parameters:

name - The name of the attribute.

ns - The Namespace

Returns:

true/false.

See Also:

Element.removeAttribute(java.lang.String,org.jdom2.Namespace)

removeAttribute

public boolean removeAttribute(java.lang.String name)

Parameters:

name - The mame of the attribute.

Returns:

true/false.

See Also:

Element.removeAttribute(java.lang.String)

removeChild

public boolean removeChild(java.lang.String name,
                           org.jdom2.Namespace ns)

Parameters:

name - The name of the child.

ns - Namespace

Returns:

true/false.

See Also:

Element.removeChild(java.lang.String,org.jdom2.Namespace)

removeChild

public boolean removeChild(java.lang.String name)

Parameters:

name - The name of the child.

Returns:

true/false.

See Also:

Element.removeChild(java.lang.String)

removeChildren

public boolean removeChildren(java.lang.String name,
                              org.jdom2.Namespace ns)

Parameters:

name - The name of the child.

ns - Namespace

Returns:

true/false.

See Also:

Element.removeChildren(java.lang.String,org.jdom2.Namespace)

removeChildren

public boolean removeChildren(java.lang.String name)

Parameters:

name - name of the child.

Returns:

true/false.

See Also:

Element.removeChildren(java.lang.String)

removeContent

public java.util.List removeContent()

Returns:

list of elements.

See Also:

Element.removeContent()

removeContent

public boolean removeContent(org.jdom2.Content child)

Parameters:

child - Content

Returns:

true/false.

See Also:

Element.removeContent(org.jdom2.Content)

removeContent

public java.util.List removeContent(org.jdom2.filter.Filter filter)

Parameters:

filter - Filter.

Returns:

list of elements.

See Also:

Element.removeContent(org.jdom2.filter.Filter)

removeContent

public org.jdom2.Content removeContent(int index)

Parameters:

index - The index.

Returns:

Content

See Also:

Element.removeContent(int)

removeNamespaceDeclaration

public void removeNamespaceDeclaration(org.jdom2.Namespace additionalNamespace)

Parameters:

additionalNamespace - Namespace.

See Also:

Element.removeNamespaceDeclaration(org.jdom2.Namespace)

setAttribute

public org.jdom2.Element setAttribute(org.jdom2.Attribute attribute)

Parameters:

attribute - Attribute

Returns:

Element.

See Also:

Element.setAttribute(org.jdom2.Attribute)

setAttribute

public org.jdom2.Element setAttribute(java.lang.String name,
                                      java.lang.String value,
                                      org.jdom2.Namespace ns)

Parameters:

name - name of the attribute.

value - The value of the attribute.

ns - Namespace.

Returns:

Element

See Also:

Element.setAttribute(java.lang.String,java.lang.String,org.jdom2.Namespace)

setAttribute

public org.jdom2.Element setAttribute(java.lang.String name,
                                      java.lang.String value)

Parameters:

name - name of the attribute.

value - The value of the attribute.

Returns:

Element

See Also:

Element.setAttribute(java.lang.String,java.lang.String)

setAttributes

public org.jdom2.Element setAttributes(java.util.List newAttributes)

Parameters:

newAttributes - list of new attributes.

Returns:

Element

setContent

public org.jdom2.Element setContent(java.util.Collection newContent)

Parameters:

newContent - Collection

Returns:

Element

See Also:

Element.setContent(java.util.Collection)

setContent

public org.jdom2.Element setContent(org.jdom2.Content child)

Parameters:

child - Content

Returns:

Element

See Also:

Element.setContent(org.jdom2.Content)

setContent

public org.jdom2.Parent setContent(int index,
                                   java.util.Collection collection)

Parameters:

index - The index.

collection - Collection

Returns:

Parent

See Also:

Element.setContent(int,java.util.Collection)

setContent

public org.jdom2.Element setContent(int index,
                                    org.jdom2.Content child)

Parameters:

index - index.

child - Content

Returns:

Element

See Also:

Element.setContent(int,org.jdom2.Content)

setName

public org.jdom2.Element setName(java.lang.String name)

Parameters:

name - The name of the element.

Returns:

Element

See Also:

Element.setName(java.lang.String)

setNamespace

public org.jdom2.Element setNamespace(org.jdom2.Namespace namespace)

Parameters:

namespace - Namespace

Returns:

Element

See Also:

Element.setNamespace(org.jdom2.Namespace)

setText

public org.jdom2.Element setText(java.lang.String text)

Parameters:

text - The text to be set.

Returns:

Element

See Also:

Element.setText(java.lang.String)

toString

public java.lang.String toString()

Element.toString()

Overrides:

toString in class java.lang.Object

getElement

public org.jdom2.Element getElement()

Returns the wrapped up JDom Element instance. Returns the wrapped up JDom Element instance that was used to create this Mergeable.

Specified by:

getElement in interface Mergeable

Returns:

the wrapped up JDom Element instance.

getElementNamesForConflictResolution

protected java.util.List getElementNamesForConflictResolution(java.util.List defaultList)

Sub classes should override if they wish to provide a different combination of composite keys for determining conflicts.

Parameters:

defaultList - the default list.

Returns:

the default list.

getDefaultMergeStrategy

protected MergeStrategy getDefaultMergeStrategy()

Returns the default MergeStrategy instance.

Returns:

MergeStrategy