Um formatador para gerar um documento XML com três formatos predefinidos que podem ser mais personalizados.
// Log an XML document with specified formatting options. var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>'; var document = XmlService.parse(xml); var output = XmlService.getCompactFormat() .setLineSeparator('\n') .setEncoding('UTF-8') .setIndent(' ') .format(document); Logger.log(output);
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
format(document) | String | Gera o Document especificado como uma string formatada. |
format(element) | String | Gera o nó Element especificado como uma string formatada. |
setEncoding(encoding) | Format | Define a codificação de caracteres que o formatador precisa usar. |
setIndent(indent) | Format | Define a string usada para recuar os nós filhos em relação aos pais. |
setLineSeparator(separator) | Format | Define a string a ser inserida sempre que o formatador normalmente insere uma quebra de linha. |
setOmitDeclaration(omitDeclaration) | Format | Define se o formatador precisa omitir a declaração XML, como <?xml version="1.0"
encoding="UTF-8"?> . |
setOmitEncoding(omitEncoding) | Format | Define se o formatador precisa omitir a codificação na declaração XML, como o
campo de codificação em <?xml version="1.0" encoding="UTF-8"?> . |
Documentação detalhada
format(document)
format(element)
setEncoding(encoding)
Define a codificação de caracteres que o formatador precisa usar. O argumento encoding
precisa
ser uma codificação XML aceita, como ISO-8859-1
, US-ASCII
, UTF-8
ou UTF-16
.
// Log an XML document with encoding that does not support certain special characters. var xml = '<root><a><b>ಠ‿ಠ</b><b>ಠ‿ಠ</b></a></root>'; var document = XmlService.parse(xml); var output = XmlService.getRawFormat() .setEncoding('ISO-8859-1') .format(document); Logger.log(output);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
encoding | String | a codificação a ser usada |
Retorno
Format
: o formatador, para encadeamento
setIndent(indent)
Define a string usada para recuar os nós filhos em relação aos pais. A definição de um recuo diferente de null
fará com que o formatador insira uma quebra de linha após cada nó.
// Log an XML document with each child node indented four spaces. var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>'; var document = XmlService.parse(xml); var output = XmlService.getCompactFormat() .setIndent(' ') .format(document); Logger.log(output);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
indent | String | o recuo a ser usado |
Retorno
Format
: o formatador, para encadeamento
setLineSeparator(separator)
Define a string a ser inserida sempre que o formatador normalmente insere uma quebra de linha. Os três
formatadores predefinidos têm condições diferentes para inserir uma quebra de linha. O
separador de linha padrão é \r\n
.
// Log an XML document with several spaces and a pipe character in place of line breaks. var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>'; var document = XmlService.parse(xml); var output = XmlService.getRawFormat() .setLineSeparator(' | ') .format(document); Logger.log(output);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
separator | String | o separador a ser usado |
Retorno
Format
: o formatador, para encadeamento
setOmitDeclaration(omitDeclaration)
Define se o formatador precisa omitir a declaração XML, como <?xml version="1.0"
encoding="UTF-8"?>
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
omitDeclaration | Boolean | true para omitir a declaração XML; false para incluí-la |
Retorno
Format
: o formatador, para encadeamento
setOmitEncoding(omitEncoding)
Define se o formatador precisa omitir a codificação na declaração XML, como o
campo de codificação em <?xml version="1.0" encoding="UTF-8"?>
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
omitEncoding | Boolean | true para omitir a codificação na declaração XML. false para incluí-la. |
Retorno
Format
: o formatador, para encadeamento