Java tutorial
/* ************************************************************************ ******************* CANADIAN ASTRONOMY DATA CENTRE ******************* ************** CENTRE CANADIEN DE DONNES ASTRONOMIQUES ************** * * (c) 2015. (c) 2015. * Government of Canada Gouvernement du Canada * National Research Council Conseil national de recherches * Ottawa, Canada, K1A 0R6 Ottawa, Canada, K1A 0R6 * All rights reserved Tous droits rservs * * NRC disclaims any warranties, Le CNRC dnie toute garantie * expressed, implied, or nonce, implicite ou lgale, * statutory, of any kind with de quelque nature que ce * respect to the software, soit, concernant le logiciel, * including without limitation y compris sans restriction * any warranty of merchantability toute garantie de valeur * or fitness for a particular marchande ou de pertinence * purpose. NRC shall not be pour un usage particulier. * liable in any event for any Le CNRC ne pourra en aucun cas * damages, whether direct or tre tenu responsable de tout * indirect, special or general, dommage, direct ou indirect, * consequential or incidental, particulier ou gnral, * arising from the use of the accessoire ou fortuit, rsultant * software. Neither the name de l'utilisation du logiciel. Ni * of the National Research le nom du Conseil National de * Council of Canada nor the Recherches du Canada ni les noms * names of its contributors may de ses participants ne peuvent * be used to endorse or promote tre utiliss pour approuver ou * products derived from this promouvoir les produits drivs * software without specific prior de ce logiciel sans autorisation * written permission. pralable et particulire * par crit. * * This file is part of the Ce fichier fait partie du projet * OpenCADC project. OpenCADC. * * OpenCADC is free software: OpenCADC est un logiciel libre ; * you can redistribute it and/or vous pouvez le redistribuer ou le * modify it under the terms of modifier suivant les termes de * the GNU Affero General Public la GNU Affero General Public * License as published by the License? telle que publie * Free Software Foundation, par la Free Software Foundation * either version 3 of the : soit la version 3 de cette * License, or (at your option) licence, soit ( votre gr) * any later version. toute version ultrieure. * * OpenCADC is distributed in the OpenCADC est distribu * hope that it will be useful, dans lespoir quil vous * but WITHOUT ANY WARRANTY; sera utile, mais SANS AUCUNE * without even the implied GARANTIE : sans mme la garantie * warranty of MERCHANTABILITY implicite de COMMERCIALISABILIT * or FITNESS FOR A PARTICULAR ni dADQUATION UN OBJECTIF * PURPOSE. See the GNU Affero PARTICULIER. Consultez la Licence * General Public License for Gnrale Publique GNU Affero * more details. pour plus de dtails. * * You should have received Vous devriez avoir reu une * a copy of the GNU Affero copie de la Licence Gnrale * General Public License along Publique GNU Affero avec * with OpenCADC. If not, see OpenCADC ; si ce nest * <http://www.gnu.org/licenses/>. pas le cas, consultez : * <http://www.gnu.org/licenses/>. * * ************************************************************************ */ package ca.nrc.cadc.ac.xml; import ca.nrc.cadc.ac.ReaderException; import ca.nrc.cadc.ac.User; import ca.nrc.cadc.xml.XmlUtil; import org.jdom2.Document; import org.jdom2.Element; import org.jdom2.JDOMException; import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; import java.io.Reader; import java.io.StringReader; import java.io.UnsupportedEncodingException; import java.net.URISyntaxException; import java.util.ArrayList; import java.util.List; /** * Class to read an XML representation of a List of Users * into a List of User objects. */ public class UserListReader extends AbstractReaderWriter { /** * Construct a List of Users from an XML String source. * * @param xml String of the XML. * @return List of users. * @throws ReaderException * @throws java.io.IOException * @throws java.net.URISyntaxException */ public List<User> read(String xml) throws ReaderException, IOException, URISyntaxException { if (xml == null) { throw new IllegalArgumentException("XML must not be null"); } return read(new StringReader(xml)); } /** * Construct a List of Users from a InputStream. * * @param in InputStream. * @return List of Users. * @throws ReaderException * @throws java.io.IOException */ public List<User> read(InputStream in) throws ReaderException, IOException { if (in == null) { throw new IOException("stream closed"); } InputStreamReader reader; try { reader = new InputStreamReader(in, "UTF-8"); } catch (UnsupportedEncodingException e) { throw new RuntimeException("UTF-8 encoding not supported"); } return read(reader); } /** * Construct a List of Users from a Reader. * * @param reader Reader. * @return List of Users. * @throws ReaderException * @throws java.io.IOException */ public List<User> read(Reader reader) throws ReaderException, IOException { if (reader == null) { throw new IllegalArgumentException("reader must not be null"); } Document document; try { document = XmlUtil.buildDocument(reader); } catch (JDOMException jde) { String error = "XML failed validation: " + jde.getMessage(); throw new ReaderException(error, jde); } Element root = document.getRootElement(); String userElemName = root.getName(); if (!userElemName.equalsIgnoreCase(USERS)) { String error = "Expected users element, found " + userElemName; throw new ReaderException(error); } return getUserList(root); } /** * Get a List of Users from a JDOM element. * * @param element The Users JDOM element. * @return A List of User objects. * @throws ReaderException */ protected final List<User> getUserList(Element element) throws ReaderException { List<User> users = new ArrayList<User>(); List<Element> userElements = element.getChildren(USER); for (Element userElement : userElements) { users.add(getUser(userElement)); } return users; } }