XmlSerializer.java

package org.reflections.serializers;

import org.dom4j.Document;
import org.dom4j.DocumentFactory;
import org.dom4j.Element;
import org.dom4j.Node;
import org.dom4j.io.OutputFormat;
import org.dom4j.io.SAXReader;
import org.dom4j.io.XMLWriter;
import org.reflections.Reflections;
import org.reflections.ReflectionsException;
import org.reflections.Store;

import java.io.File;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

/**
 * xml serialization for {@link org.reflections.Reflections} <pre>{@code reflections.save(file, new XmlSerializer())}</pre>
 * <p></p>an example of produced xml:
 * <pre>{@code
 * <Reflections>
 *   <SubTypes>
 *     <entry>
 *       <key>org.reflections.TestModel$C1</key>
 *       <values>
 *         <value>org.reflections.TestModel$C2</value>
 *         <value>org.reflections.TestModel$C3</value>
 *       </values>
 *     </entry>
 *   </SubTypes>
 *   <TypesAnnotated>
 *     <entry>
 *       <key>org.reflections.TestModel$AC2</key>
 *       <values>
 *         <value>org.reflections.TestModel$C2</value>
 *         <value>org.reflections.TestModel$C3</value>
 *       </values>
 *     </entry>
 *   </TypesAnnotated>
 * </Reflections>
 * }</pre>
 */
public class XmlSerializer implements Serializer {

	public Reflections read(InputStream inputStream) {
		try {
			Document document = new SAXReader().read(inputStream);
			Map<String, Map<String, Set<String>>> storeMap =
				document.getRootElement()
					.elements().stream()
					.collect(Collectors.toMap(Node::getName,
						index -> index.elements().stream().collect(Collectors.toMap(
							entry -> entry.element("key").getText(),
							entry -> entry.element("values").elements().stream().map(Element::getText).collect(Collectors.toSet())))));
			return new Reflections(new Store(storeMap));
		} catch (Exception e) {
			throw new ReflectionsException("could not read.", e);
		}
	}

	public File save(Reflections reflections, String filename) {
		File file = Serializer.prepareFile(filename);
		try (FileOutputStream out = new FileOutputStream(file)) {
			new XMLWriter(out, OutputFormat.createPrettyPrint())
				.write(createDocument(reflections.getStore()));
		} catch (Exception e) {
			throw new ReflectionsException("could not save to file " + filename, e);
		}
		return file;
	}

	private Document createDocument(Store store) {
		Document document = DocumentFactory.getInstance().createDocument();
		Element root = document.addElement("Reflections");
		store.forEach((index, map) -> {
			Element indexElement = root.addElement(index);
			map.forEach((key, values) -> {
				Element entryElement = indexElement.addElement("entry");
				entryElement.addElement("key").setText(key);
				Element valuesElement = entryElement.addElement("values");
				values.forEach(value -> valuesElement.addElement("value").setText(value));
			});
		});
		return document;
	}
}