Package net.ssehub.easy.instantiation.core.model.artifactModel.xml

Class XmlComment

java.lang.Object

net.ssehub.easy.instantiation.core.model.artifactModel.FragmentArtifact

net.ssehub.easy.instantiation.core.model.artifactModel.CompositeFragmentArtifact

net.ssehub.easy.instantiation.core.model.artifactModel.xml.XmlNode

net.ssehub.easy.instantiation.core.model.artifactModel.xml.XmlComment

All Implemented Interfaces:

IArtifact, IArtifactChangedListener, IStringValueProvider, IVilType

public class XmlComment
extends XmlNode

Represents an XML comment.

Author:

Holger Eichelberger

Nested Class Summary

Nested classes/interfaces inherited from interface net.ssehub.easy.instantiation.core.model.vilTypes.IStringValueProvider

IStringValueProvider.StringComparator

Constructor Summary

Constructors

Constructor	Description
XmlComment(XmlElement parent, org.w3c.dom.Node node)	Creates a new XML comment fragment artifact.

Method Summary

Modifier and Type	Method	Description
static XmlComment	create(XmlElement parent, java.lang.String contents)	Creates a new XmlComment as child of given parent.
(package private) void	deleteChild(XmlNode child)	Removes a child from this Element.
java.lang.String	getName()	Returns the name of this artifact.
java.lang.String	getStringValue(IStringValueProvider.StringComparator comparator)	Returns the string value of this object.
void	rename(java.lang.String name)	Renames this artifact.
Set<? extends FragmentArtifact>	selectAll()	Returns all artifacts this composite artifact is composed of.

Methods inherited from class net.ssehub.easy.instantiation.core.model.artifactModel.xml.XmlNode

accept, artifactChanged, checkRoot, checkValidity, delete, getBinary, getCdata, getCdataDirect, getChild, getChildCount, getFile, getNameSafe, getNode, getParent, getText, getTextDirect, notifyChange, notifyChange, setCdata, setNode, sortAttributes, synchronizeAttributeSequence, update

Methods inherited from class net.ssehub.easy.instantiation.core.model.artifactModel.FragmentArtifact

exists, lastModification, store

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlComment

XmlComment(XmlElement parent,
           org.w3c.dom.Node node)

Creates a new XML comment fragment artifact.

Parameters:

parent - the parent artifact

node - the node that is represented by this XmlElement

Method Detail

create

public static XmlComment create(XmlElement parent,
                                java.lang.String contents)
                         throws VilException

Creates a new XmlComment as child of given parent.

Parameters:

parent - The parent of the new XmlComment.

contents - optional initial contents, ignored if empty

Returns:

The created XmlElement.

Throws:

VilException - if element could not be created.

getStringValue

public java.lang.String getStringValue(IStringValueProvider.StringComparator comparator)

Description copied from interface: IStringValueProvider

Returns the string value of this object.

Parameters:

comparator - if the sequence of elements, e.g., in case of collections, shall be ordered according to the comparator, null if the original sequence shall be returned

Returns:

the string value

getName

public java.lang.String getName()
                         throws VilException

Description copied from interface: IArtifact

Returns the name of this artifact.

Returns:

the name of this artifact

Throws:

VilException - in case of serious problems so that this operation cannot continue

rename

public void rename(java.lang.String name)
            throws VilException

Description copied from interface: IArtifact

Renames this artifact.

Parameters:

name - the new name of this artifact

Throws:

VilException - in case of serious problems so that this operation cannot continue

selectAll

public Set<? extends FragmentArtifact> selectAll()
                                          throws VilException

Description copied from class: CompositeFragmentArtifact

Returns all artifacts this composite artifact is composed of.

Specified by:

selectAll in class CompositeFragmentArtifact

Returns:

all fragments

Throws:

VilException - in case that this element or query is invalid

deleteChild

void deleteChild(XmlNode child)

Description copied from class: XmlNode

Removes a child from this Element.

Specified by:

deleteChild in class XmlNode

Parameters:

child - the child that is to be removed.