Processing:Справочник языка Processing/XML/format()

Содержание

Среда разработки Processing

Справочник языка Processing

Библиотеки

Примеры

Режимы программирования

Перевод: Максим Кузьмин

Проверка/Оформление/Редактирование: Мякишев Е.А.

format()

Класс

XML

Обозначение

format()

Описание

Конвертирует объект XML в значение String, форматируя его содержимое в соответствии с заданным параметром indent.

Если в параметре indent указано значение «-1», то метод вернет значение String без переводов строки, смещения текста вправо и XML-декларации.

Если в параметре indent указано значение «0» или больше, метод вернет значение String с переводами строки, а также со смещением текста вправо на количество пробелов, указанных в параметре indent. Другими словами, если в indent будет указано «0», то пробелов перед текстом не будет, а если в indent будет указано «1», «2», «3» и т.д., то перед текстом будут стоять пробелы, чье количество будет соответствовать этому значению – один, два, три и т.д.

Синтаксис

.format(indent)

Параметры

indent – «-1» для одной цельной строки (без XML-декларации); «0» или больше для смещения текста вправо и перевода строки. Тип данных – int.

Возвращаемое значение

Тип данных – String

Пример

// В скетче ниже выполняется разбор XML-файла "mammals.xml". 
// Он должен находиться в папке "data" проекта.
//
// <?xml version="1.0"?>
// <mammals>
//   <animal id="0" species="Capra hircus">Goat</animal>
//   <animal id="1" species="Panthera pardus">Leopard</animal>
//   <animal id="2" species="Equus zebra">Zebra</animal>
// </mammals>

XML xml;

void setup() {
  xml = loadXML("mammals.xml");
  
  // форматирование без перевода строки и смещения вправо:
  String s = xml.format(-1);
  println(s);
  println("");  //  пустая линия
  
  // форматирование с переводом строки и без смещения вправо:
  s = xml.format(0);
  println(s);
  
  // форматирование с переводом строки
  // и смещением вправо на 5 пробелов: 
  s = xml.format(5);
  println(s);
}

// Скетч напечатает:
//<mammals><animal id="0" species="Capra hircus">Goat</animal>
  <animal id="1" species="Panthera pardus">Leopard</animal>
  <animal id="2" species="Equus zebra">Zebra</animal></mammals>
//
//<?xml version="1.0" encoding="UTF-8"?>
//<mammals>
//<animal id="0" species="Capra hircus">Goat</animal>
//<animal id="1" species="Panthera pardus">Leopard</animal>
//<animal id="2" species="Equus zebra">Zebra</animal>
//</mammals>
//
//<?xml version="1.0" encoding="UTF-8"?>
//<mammals>
//     <animal id="0" species="Capra hircus">Goat</animal>
//     <animal id="1" species="Panthera pardus">Leopard</animal>
//     <animal id="2" species="Equus zebra">Zebra</animal>
//</mammals>