ObjectXmlComment

Els objectes XmlComment representen el contingut dels nodes de comentari del document

El node XmlComment representa un comentari en un document XML. Utilitzat perXmlCharacterDataL'atribut de dades heretat per la interfície o utilitzant elXmlNodeL'atribut nodeValue heretat per la interfície pot accedir al contingut de l'anotació. (és a dir, el text entre ). Utilitzat perXmlCharacterDataDiversos mètodes heretats de la interfície poden operar sobre el contingut de l'anotació.

utilitzarXmlDocument.createComment() per crear un objecte d'anotació.

relació hereditària

propietats dels membres

data

String, el text contingut en aquest node

1
String XmlComment.data;

---

length

Enter, el nombre de caràcters continguts en aquest 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

String, 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 l'atribut
• XmlText: #text
• XmlCDATASection: #cdata-section
• XmlProcessingInstruction: retorna l'objectiu objectiu especificat
• XmlComment: #comentar
• XmlDocument: #document
• XmlDocumentType: nom del tipus de document

---

nodeValue

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

1
String XmlComment.nodeValue;

El nodeName de diferents objectes retornarà diferents valors:

• XmlElement: nul
• XmlAttr: valor de l'atribut
• XmlText: el contingut del node
• XmlCDATASection: el contingut del node
• XmlProcessingInstruction: retorna les dades de contingut especificades
• XmlComment: text d'anotació
• XmlDocument: nul
• XmlDocumentType: nul

---

ownerDocument

XmlDocument, retorna l'element arrel del node (XmlDocumentobjecte)

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;

---

children

XmlNodeList, retorna la llista de nodes dels nodes de l'element fill del node especificat.

1
readonly XmlNodeList XmlComment.children;

---

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 anterior a un node (al mateix nivell d'arbre). Si no hi ha aquest node, aquesta propietat retorna null.

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, l'atribut retorna null.

1
readonly XmlNode XmlComment.nextSibling;

---

firstElementChild

XmlNode, retorna el primer node element fill del node

1
readonly XmlNode XmlComment.firstElementChild;

---

lastElementChild

XmlNode, retorna l'últim node d'element fill del node

1
readonly XmlNode XmlComment.lastElementChild;

---

previousElementSibling

XmlNode, retorna el node d'element immediatament anterior a un node (al mateix nivell d'arbre). Si no hi ha aquest node, aquesta propietat retorna null.

1
readonly XmlNode XmlComment.previousElementSibling;

---

nextElementSibling

XmlNode, retorna el node d'element immediatament després d'un element (al mateix nivell d'arbre). Si no hi ha aquest node, l'atribut retorna null.

1
readonly XmlNode XmlComment.nextElementSibling;

---

textContent

Cadena, consulta i estableix el text de l'element seleccionat. Quan es consulta, retorna els valors de tots els nodes de text dins del node d'element; quan es configura, elimina tots els nodes fills i els substitueix per un sol node de text.

1
String XmlComment.textContent;

funció de membre

substringData

Extreu la subcadena del node

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

Paràmetres de trucada:

• offset: Enter, la posició del primer caràcter a retornar
• count: Enter, el nombre de caràcters de la subcadena que s'ha de retornar

Resultats de retorn:

• String, retorna la cadena extreta

---

appendData

Afegeix una cadena al node

1
XmlComment.appendData(String arg);

Paràmetres de trucada:

• arg: String, la cadena que s'ha d'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 en què s'ha d'inserir la cadena al node
• arg: String, la cadena que cal inserir

---

deleteData

Elimina 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 s'ha d'eliminar
• count: Enter, el nombre de caràcters que cal 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 que s'ha de substituir
• count: Enter, el nombre de caràcters a substituir
• arg: String, la cadena que cal inserir

---

hasChildNodes

Consulta si hi ha nodes fills

1
Boolean XmlComment.hasChildNodes();

Resultats de retorn:

• Boolean, retorna true si hi ha nodes fills, en cas contrari retorna false

---

normalize

Combina els nodes de text adjacents i suprimeix els nodes de text buits

1
XmlComment.normalize();

Aquest mètode travessarà tots els nodes descendents del node actual i normalitzarà el document eliminant els nodes de text buits 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

Crea una còpia exacta del node especificat

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

Paràmetres de trucada:

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

Resultats de retorn:

• XmlNode, retorna el node copiat

Aquest mètode copiarà i retornarà una còpia del node on s'ha cridat. Si l'argument que se li passa és cert, també copiarà de manera recursiva tots els nodes 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 copia un node Element, es copiaran totes les seves propietats.

---

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: String, especifica l'URI de l'espai de noms coincident

Resultats de retorn:

• String, retorna el prefix coincident, retorna null 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, especifica el prefix coincident

Resultats de retorn:

• String, retorna l'URI de l'espai de noms coincident, retorna null si no coincideix.

---

insertBefore

Inseriu un nou node fill abans d'un 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

Resultats de retorn:

• XmlNode, retorna el nou node fill

Si newChild ja existeix a l'arbre del document, s'eliminarà de l'arbre del document i es tornarà a inserir a la seva nova posició. Els nodes d'un document (o nodes creats per un document) no es poden inserir en un altre document. És a dir, l'atribut ownerDocument de newChild ha de ser el mateix que l'atribut ownerDocument del node actual.

---

insertAfter

Inseriu un nou node fill després d'un 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

Resultats de retorn:

• XmlNode, retorna el nou node fill

Si newChild ja existeix a l'arbre del document, s'eliminarà de l'arbre del document i es tornarà a inserir a la seva nova posició. Els nodes d'un document (o nodes creats per un document) no es poden inserir en un altre document. És a dir, l'atribut ownerDocument de newChild ha de ser el mateix que l'atribut ownerDocument del node actual.

---

appendChild

Afegeix un nou node fill al final de la llista de nodes fill d'un node

1
XmlNode XmlComment.appendChild(XmlNode newChild);

Paràmetres de trucada:

• newChild:XmlNode, especifiqueu el node afegit

Resultats de retorn:

• XmlNode, retorna aquest nou node fill

Si newChild ja existeix a l'arbre del document, s'eliminarà de l'arbre del document i es tornarà a inserir a la seva nova posició. Els nodes d'un document (o nodes creats per un document) no es poden inserir en un altre document. És a dir, l'atribut ownerDocument de newChild ha de ser el mateix que l'atribut ownerDocument del node actual.

---

replaceChild

Substituïu un node fill per un altre

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

Paràmetres de trucada:

• newChild:XmlNode, especifiqueu el nou node
• oldChild:XmlNode, especifica el node que s'ha de substituir

Resultats de retorn:

• XmlNode, Si la substitució té èxit, aquest mètode pot retornar el node substituït. Si la substitució falla, retorna nul.

Si newChild ja existeix a l'arbre del document, s'eliminarà de l'arbre del document i es tornarà a inserir a la seva nova posició. Els nodes d'un document (o nodes creats per un document) no es poden inserir en un altre document. És a dir, l'atribut ownerDocument de newChild ha de ser el mateix que l'atribut ownerDocument del node actual.

---

removeChild

Elimina un node de la llista de nodes fills

1
XmlNode XmlComment.removeChild(XmlNode oldChild);

Paràmetres de trucada:

• oldChild:XmlNode, especifica el node que s'ha de suprimir

Resultats de retorn:

• XmlNode, Si la supressió és correcta, aquest mètode pot retornar el node suprimit. Si falla, retorna null.

---

toString

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

1
String XmlComment.toString();

Resultats de retorn:

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

---

toJSON

Retorna una representació en format JSON de l'objecte, generalment retornant una col·lecció de propietats llegibles definides per l'objecte.

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

Paràmetres de trucada:

• key: Corda, no utilitzada

Resultats de retorn:

• Value, retorna un valor que conté JSON serializable