matlab.io.xml.dom.Comment Class

Namespace: matlab.io.xml.dom

Comment in XML document

Since R2021a

Description

An object of the mlreportgen.io.xml.dom.Comment class represents a comment in an XML document.

The matlab.io.xml.dom.Comment class is a handle class.

Class Attributes

ConstructOnLoad	true
HandleCompatible	true

For information on class attributes, see Class Attributes.

Creation

Create a matlab.io.xml.dom.Comment object by using the createComment method of a matlab.io.xml.dom.Document object.

Properties

Length — Number of characters in comment

double

Number of characters in the comment, specified as a double.

Attributes:

GetAccess	public
SetAccess	immutable
Transient	true
NonCopyable	true

TextContent — Text content of comment

character vector

Text content of the comment, specified as a character vector.

Attributes:

GetAccess	public
SetAccess	immutable
Transient	true
NonCopyable	true

Methods

Public Methods

appendData	appendData(thisComment,characters) appends characters to the end of the character data in this comment. Specify characters as a character vector or string scalar.
cloneNode	copy = cloneNode(thisComment,deep) creates a copy of this comment and returns the copy. If deep is true, the copy is a deep copy. If deep is false, the copy is a shallow copy.
compareDocumentPosition	posEnum = compareDocumentPosition(thisComment,otherNode) returns a double value that encodes the position of otherNode relative to the position of thisComment in the document that owns thisComment. To decode the returned value, posEnum, use the MATLAB expression bitor(posEnum,POSITION_ENUM) == posEnum, where POSITION_ENUM is one of these Comment methods: DOCUMENT_POSITION_FOLLOWING — The other node follows this comment node. DOCUMENT_POSITION_PRECEDING — The other node precedes this comment node. DOCUMENT_POSITION_CONTAINED_BY — This comment node contains the other node, which also follows this node. DOCUMENT_POSITION_CONTAINS — The other node contains this comment node and also precedes this node. DOCUMENT_POSITION_DISCONNECTED — The two nodes are disconnected. For example: import matlab.io.xml.dom.* d = Document("root"); root = getDocumentElement(d); comment = createComment(d,"Example of a comment"); appendChild(root,comment); pos = compareDocumentPosition(comment,root); if bitor(pos,comment.DOCUMENT_POSITION_CONTAINS)... == pos disp("root contains comment"); else disp("root does not contain comment"); end
deleteData	deleteData(thisComment,offset,count) deletes a range of characters from the text in this comment. The offset argument is the zero-based index of the first character to delete, specified as an integer. The count argument is the number of characters to delete, specified as an integer.
getBaseURI	uri = getBaseURI(thisComment) returns the base URI of this comment as a character vector. The base URI of a comment is the URI of the document that owns the comment.
getData	str = getData(thisComment) returns the character data in this comment as a character vector.
getLength	count = getLength(thisComment) returns the number of characters in this comment as a double.
getNextSibling	sibling = getNextSibling(thisComment) returns the node that follows this comment in the child list of the parent of this comment node.
getNodeName	name = getNodeName(thisComment) returns '#comment'.
getNodeTypeName	name = getNodeTypeName(thisComment) returns 'COMMENT_NODE'.
getNodeValue	value = getNodeValue(thisComment) returns the content of this comment as a character vector.
getOwnerDocument	doc = getOwnerDocument(thisComment) returns the document that owns this comment. The owner document is the document that created or imported this comment.
getParentNode	parent = getParentNode(thisComment) returns the parent of this comment. If this comment does not have a parent, the method returns an empty node.
getPreviousSibling	sibling = getPreviousSibling(thisComment) returns the node that precedes this comment in the child list of the parent of this comment.
getTextContent	text = getTextContent(thisComment) returns the character data in this comment as a character vector.
insertData	insertData(thisComment,index,data) inserts character data at the position specified by the zero-based index argument. Specify data as a character vector or string scalar.
isEqualNode	tf = isEqualNode(thisComment,otherNode) returns true if the node specified by otherNode is a comment node and has the same text content as thisComment. This method tests for equality of nodes, not whether the nodes are handles to the same object. To test for sameness, use the isSameNode method. Nodes that are the same are also equal, but nodes that are equal are not necessarily the same. Normalize documents before testing them for equality because normalization can affect equality.
isSameNode	tf = isSameNode(thisComment,otherNode) returns true if otherNode is the same node as thisComment.
replaceData	replaceData(thisComment,index,count,data) replaces the number of characters specified by count in the text content of this comment node, starting at the position specified by the zero-based index, with the characters specified by data. Specify index and count as integers. Specify data as a character vector or string scalar.
setData	setData(thisComment,data) replaces the current content of this comment node with the text specified by data. Specify data as a character vector or string scalar.
setNodeValue	setNodeValue(thisComment,value) sets the text content of this comment node to the text specified by value. Specify value as a character vector or string scalar.
setTextContent	setTextContent(thisComment,textContent) sets the text content in this comment node to the text specified by textContent. Specify textContent as a character vector or string scalar.
splitText	newNode = splitText(thisComment,index) splits this comment node into two comment nodes at the specified zero-based index and returns the new comment node. After the split, the original comment node contains the original text up to the index. The new node contains the original text from the index. If the index equals the length of the original text, the new node is empty. If this comment node has a parent, the method inserts the new comment node after this comment node in the parent node.
substringData	substringData(thisComment,index,count) returns the characters specified by index and count. Index is the zero-based position of the first character to return and count is the number of characters to return. Specify index and count as integers.

Examples

Add Comment to Document

This example adds a comment to the root node of an XML document that represents the days of the week.

Create a matlab.io.xml.dom.Document object with a root element named weekdays.

import matlab.io.xml.dom.*
doc = Document("weekdays");
docRootNode = getDocumentElement(doc);

Use the createComment method of the Document object to create a comment. Append the comment to the root element.

appendChild(docRootNode,createComment(doc,"days of the week except Saturday and Sunday"));

For each week day, Monday through Friday, create an element named day and append the name of the day to the day element. Append the day elements to the root element.

weekdays = ["Mon" "Tue" "Wed" "Thu" "Fri"];
for i=1:5
    dayElement = createElement(doc,"day");
    appendChild(dayElement,createTextNode(doc,weekdays(i)));
    appendChild(docRootNode,dayElement);
end

Write the document to the file weekdays.xml;

xmlFileName = "weekdays.xml";
writer = matlab.io.xml.dom.DOMWriter;
writer.Configuration.FormatPrettyPrint = true;
writeToFile(writer,doc,xmlFileName);

Display the file contents.

type weekdays.xml;

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<weekdays>
  <!--days of the week except Saturday and Sunday-->
  <day>Mon</day>
  <day>Tue</day>
  <day>Wed</day>
  <day>Thu</day>
  <day>Fri</day>
</weekdays>

The comment <!--days of the week except Saturday and Sunday--> immediately follows the opening tag of the root element weekdays.

Version History

Introduced in R2021a