Objecte XmlComment

L'objecte XmlComment representa el contingut del node de comentaris al document

El node XmlComment representa un comentari al document XML. Utilitzat perXmlCharacterData L'atribut de dades heretat per la interfície o utilitzar el fitxer XmlNodeLa propietat nodeValue heretada per la interfície pot accedir al contingut de l’anotació. (És a dir, el text entre). Utilitzat perXmlCharacterData Diversos mètodes heretats per la interfície poden manipular el contingut del comentari.

ús XmlDocument.createComment() per crear un objecte de comentari.

Herència

Atributs de membre

data

Cadena, el text contingut al node

1
String XmlComment.data;

---

length

Enter, el nombre de caràcters continguts al node

1
readonly Integer XmlComment.length;

---

nodeType

Enter, retorna el tipus de node del node

1
readonly Integer XmlComment.nodeType;

El nodeType de diferents objectes retornarà diferents valors:

• XmlElement: ELEMENT_NODE (1)
• XmlAttr: ATTRIBUTE_NODE (2)
• XmlText: TEXT_NODE (3)
• XmlCDATASection: CDATA_SECTION_NODE (4)
• XmlProcessingInstruction: PROCESSING_INSTRUCTION_NODE (7)
• XmlComment: COMMENT_NODE (8)
• XmlDocument: DOCUMENT_NODE (9)
• XmlDocumentType: DOCUMENT_TYPE_NODE (10)

---

nodeName

Cadena, retorna el nom del node, segons el seu tipus

1
readonly String XmlComment.nodeName;

El nodeName de diferents objectes retornarà diferents valors:

• XmlElement: nom de l'element
• XmlAttr: Nom de la propietat
• XmlText: #text
• XmlCDATASection: # cdata-section
• XmlProcessingInstruction: Torneu a l'objectiu especificat
• XmlComment: #comentari
• XmlDocument: #document
• XmlDocumentType: nom doctype

---

nodeValue

Cadena, retorna el nom del node, segons el seu tipus

1
String XmlComment.nodeValue;

El nodeName de diferents objectes retornarà diferents valors:

• XmlElement: nul
• XmlAttr: El valor de l'atribut
• XmlText: El contingut del node
• XmlCDATASection: El contingut del node
• XmlProcessingInstruction: Retorna les dades de contingut especificades
• XmlComment: Text de comentari
• XmlDocument: nul
• XmlDocumentType: nul

---

ownerDocument

XmlDocument, Retorna l'element arrel del node (XmlDocument Objecte)

1
readonly XmlDocument XmlComment.ownerDocument;

---

parentNode

XmlNode, Pot retornar el node pare d'un node

1
readonly XmlNode XmlComment.parentNode;

---

childNodes

XmlNodeList, Retorna la llista de nodes dels nodes fills del node especificat

1
readonly XmlNodeList XmlComment.childNodes;

---

firstChild

XmlNode, Retorna el primer node fill del node

1
readonly XmlNode XmlComment.firstChild;

---

lastChild

XmlNode, Retorna l'últim node fill del node

1
readonly XmlNode XmlComment.lastChild;

---

previousSibling

XmlNode, Retorna el node immediatament abans d’un determinat node (al mateix nivell d’arbre), si no hi ha aquest node, l’atribut torna nul

1
readonly XmlNode XmlComment.previousSibling;

---

nextSibling

XmlNode, Retorna el node immediatament després d'un element (al mateix nivell d'arbre), si no hi ha aquest node, la propietat torna nul

1
readonly XmlNode XmlComment.nextSibling;

Funció de membre

substringData

Extraieu la subcadena del node

1
2
String XmlComment.substringData(Integer offset,
    Integer count);

Paràmetres de trucada:

• offset: Enter, la posició del primer personatge que es retorna
• count: Enter, el nombre de caràcters de la subcadena a retornar

Resultat de retorn:

• String, Retorna la cadena extreta

---

appendData

Afegiu la cadena al node

1
XmlComment.appendData(String arg);

Paràmetres de trucada:

• arg: Cadena, la cadena que cal afegir al node

---

insertData

Inseriu una cadena al node

1
2
XmlComment.insertData(Integer offset,
    String arg);

Paràmetres de trucada:

• offset: Enter, la posició del caràcter on s'ha d'inserir la cadena al node
• arg: Cadena, la cadena que cal inserir

---

deleteData

Suprimiu el text del node

1
2
XmlComment.deleteData(Integer offset,
    Integer count);

Paràmetres de trucada:

• offset: Enter, la posició del primer caràcter que se suprimeix
• count: Enter, el nombre de caràcters a suprimir

---

replaceData

Substituïu els caràcters del node per la cadena especificada

1
2
3
XmlComment.replaceData(Integer offset,
    Integer count,
    String arg);

Paràmetres de trucada:

• offset: Enter, la posició del caràcter del node a substituir
• count: Enter, el nombre de caràcters a substituir
• arg: Cadena, la cadena que cal inserir

---

hasChildNodes

Consulteu si hi ha nodes secundaris

1
Boolean XmlComment.hasChildNodes();

Resultat de retorn:

• Boolean, Torneu a true si hi ha nodes secundaris, en cas contrari, torneu a false

---

normalize

Combineu els nodes de text adjacents i suprimiu els nodes de text buits

1
XmlComment.normalize();

Aquest mètode recorrerà tots els nodes descendents del node actual i normalitzarà el document suprimint el node de text buit i fusionant tots els nodes de text adjacents. Aquest mètode és útil per simplificar l'estructura de l'arbre del document després d'inserir o suprimir nodes.

---

cloneNode

Creeu una còpia exacta del node especificat

1
XmlNode XmlComment.cloneNode(Boolean deep = true);

Paràmetres de trucada:

• deep: Booleà, si voleu copiar en profunditat, quan és cert, el node clonat clonarà tots els nodes fills del node original

Resultat de retorn:

• XmlNode, Retorna el node copiat

Aquest mètode copiarà i retornarà una còpia del node que l’ha anomenat. Si el paràmetre que se li passa és cert, també copiarà recursivament tots els descendents del node actual. En cas contrari, només copia el node actual. El node retornat no pertany a l'arbre del document i la seva propietat parentNode és nul·la. Quan es copiï el node Element, es copiaran tots els seus atributs.

---

lookupPrefix

Retorna el prefix que coincideix amb l'URI de l'espai de noms especificat al node actual

1
String XmlComment.lookupPrefix(String namespaceURI);

Paràmetres de trucada:

• namespaceURI: Cadena, especifiqueu l'URI de l'espai de noms coincident

Resultat de retorn:

• String, Retorna el prefix coincident, torna nul si no coincideix

---

lookupNamespaceURI

Retorna l'URI de l'espai de noms que coincideix amb el prefix especificat al node actual

1
String XmlComment.lookupNamespaceURI(String prefix);

Paràmetres de trucada:

• prefix: Cadena, especifiqueu el prefix coincident

Resultat de retorn:

• String, Retorna l'URI de l'espai de noms coincident, torna nul si no coincideix

---

insertBefore

Inseriu un node fill nou abans del node fill existent

1
2
XmlNode XmlComment.insertBefore(XmlNode newChild,
    XmlNode refChild);

Paràmetres de trucada:

• newChild: XmlNode, Inseriu un nou node
• refChild: XmlNode, Inseriu un nou node abans d'aquest node

Resultat de retorn:

• XmlNode, Retorna el nou node fill

Si newChild ja existeix a l'arbre del document, se suprimirà de l'arbre del document i es reintroduirà a la nova posició. Els nodes d'un document (o nodes creats per un document) no es poden inserir en un altre document. En altres paraules, la propietat ownerDocument de newChild ha de ser la mateixa que la propietat ownerDocument del node actual.

---

insertAfter

Inseriu un node fill nou després del node fill existent

1
2
XmlNode XmlComment.insertAfter(XmlNode newChild,
    XmlNode refChild);

Paràmetres de trucada:

• newChild: XmlNode, Inseriu un nou node
• refChild: XmlNode, Inseriu un nou node després d'aquest node

Resultat de retorn:

• XmlNode, Retorna el nou node fill

Si newChild ja existeix a l'arbre del document, se suprimirà de l'arbre del document i es reintroduirà a la nova posició. Els nodes d'un document (o nodes creats per un document) no es poden inserir en un altre document. En altres paraules, la propietat ownerDocument de newChild ha de ser la mateixa que la propietat ownerDocument del node actual.

---

appendChild

Afegiu un node fill nou al final de la llista de nodes fills del node

1
XmlNode XmlComment.appendChild(XmlNode newChild);

Paràmetres de trucada:

• newChild: XmlNode, Especifiqueu el node afegit

Resultat de retorn:

• XmlNode, Retorna aquest nou node fill

Si newChild ja existeix a l'arbre del document, se suprimirà de l'arbre del document i es reintroduirà a la nova posició. Els nodes d'un document (o nodes creats per un document) no es poden inserir en un altre document. En altres paraules, la propietat ownerDocument de newChild ha de ser la mateixa que la propietat ownerDocument del node actual.

---

replaceChild

Substitueix un node fill per un altre

1
2
XmlNode XmlComment.replaceChild(XmlNode newChild,
    XmlNode oldChild);

Paràmetres de trucada:

• newChild: XmlNode, Especifiqueu un nou node
• oldChild: XmlNode, Especifiqueu el node a substituir

Resultat de retorn:

• XmlNode, Si la substitució és correcta, aquest mètode pot retornar el node substituït; si la substitució falla, torna nul

Si newChild ja existeix a l'arbre del document, se suprimirà de l'arbre del document i es reintroduirà a la nova posició. Els nodes d'un document (o nodes creats per un document) no es poden inserir en un altre document. En altres paraules, la propietat ownerDocument de newChild ha de ser la mateixa que la propietat ownerDocument del node actual.

---

removeChild

Elimineu un node de la llista de nodes secundaris

1
XmlNode XmlComment.removeChild(XmlNode oldChild);

Paràmetres de trucada:

• oldChild: XmlNode, Especifiqueu el node a suprimir

Resultat de retorn:

• XmlNode, Si la supressió és correcta, aquest mètode pot retornar el node suprimit; si falla, torna nul

---

toString

Retorna la representació de cadena de l'objecte, generalment retorna "[Objecte natiu]", l'objecte es pot tornar a implementar segons les seves pròpies característiques

1
String XmlComment.toString();

Resultat de retorn:

• String, Retorna la representació de cadena de l'objecte

---

toJSON

Retorna la representació en format JSON de l'objecte, generalment retorna una col·lecció d'atributs llegibles definits per l'objecte

1
Value XmlComment.toJSON(String key = "");

Paràmetres de trucada:

• key: Cadena, sense utilitzar

Resultat de retorn:

• Value, Retorna un valor que conté JSON serialitzable