Class Format

Formato

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étodoTipo de retornoBreve descrição
format(document)StringGera o Document especificado como uma string formatada.
format(element)StringGera o nó Element especificado como uma string formatada.
setEncoding(encoding)FormatDefine a codificação de caracteres que o formatador precisa usar.
setIndent(indent)FormatDefine a string usada para recuar os nós filhos em relação aos pais.
setLineSeparator(separator)FormatDefine a string a ser inserida sempre que o formatador normalmente insere uma quebra de linha.
setOmitDeclaration(omitDeclaration)FormatDefine se o formatador precisa omitir a declaração XML, como <?xml version="1.0" encoding="UTF-8"?>.
setOmitEncoding(omitEncoding)FormatDefine 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)

Gera o Document especificado como uma string formatada.

Parâmetros

NomeTipoDescrição
documentDocumento documento para formatar

Retorno

String: o documento formatado.


format(element)

Gera o nó Element especificado como uma string formatada.

Parâmetros

NomeTipoDescrição
elementElemento elemento a ser formatado

Retorno

String: o elemento formatado


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

NomeTipoDescrição
encodingStringa 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

NomeTipoDescrição
indentStringo 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

NomeTipoDescrição
separatorStringo 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

NomeTipoDescrição
omitDeclarationBooleantrue 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

NomeTipoDescrição
omitEncodingBooleantrue para omitir a codificação na declaração XML. false para incluí-la.

Retorno

Format: o formatador, para encadeamento