All Downloads are FREE. Search and download functionalities are using the official Maven repository.

ca.nrc.cadc.util.MultiValuedProperties Maven / Gradle / Ivy

The newest version!
/*
************************************************************************
*******************  CANADIAN ASTRONOMY DATA CENTRE  *******************
**************  CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES  **************
*
*  (c) 2019.                            (c) 2019.
*  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 réservés
*
*  NRC disclaims any warranties,        Le CNRC dénie toute garantie
*  expressed, implied, or               énoncée, implicite ou légale,
*  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 général,
*  arising from the use of the          accessoire ou fortuit, résultant
*  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 utilisés pour approuver ou
*  products derived from this           promouvoir les produits dérivés
*  software without specific prior      de ce logiciel sans autorisation
*  written permission.                  préalable et particulière
*                                       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 publiée
*  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 ultérieure.
*
*  OpenCADC is distributed in the       OpenCADC est distribué
*  hope that it will be useful,         dans l’espoir qu’il vous
*  but WITHOUT ANY WARRANTY;            sera utile, mais SANS AUCUNE
*  without even the implied             GARANTIE : sans même la garantie
*  warranty of MERCHANTABILITY          implicite de COMMERCIALISABILITÉ
*  or FITNESS FOR A PARTICULAR          ni d’ADÉQUATION À UN OBJECTIF
*  PURPOSE.  See the GNU Affero         PARTICULIER. Consultez la Licence
*  General Public License for           Générale Publique GNU Affero
*  more details.                        pour plus de détails.
*
*  You should have received             Vous devriez avoir reçu une
*  a copy of the GNU Affero             copie de la Licence Générale
*  General Public License along         Publique GNU Affero avec
*  with OpenCADC.  If not, see          OpenCADC ; si ce n’est
*  .      pas le cas, consultez :
*                                       .
*
*  $Revision: 5 $
*
************************************************************************
*/

package ca.nrc.cadc.util;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * A properties file reader that allows a property to have multiple values.
 * The java.util.Properties class is a HashTable so only permits one
 * value.
 *
 * @author pdowler
 */
public class MultiValuedProperties {
    
    private final Map> props = new HashMap>();

    public MultiValuedProperties() { }

    public boolean isEmpty() {
        return props.isEmpty();
    }
    
    /**
     * Get all values for a property.
     * 
     * @param name
     * @return possibly empty list of values
     */
    public List getProperty(String name) {
        if (props == null) {
            throw new IllegalStateException("no properties loaded");
        }
        
        List ret = props.get(name);
        if (ret == null) {
            ret = Collections.emptyList();
        }
        return ret;
    }

    /**
     * Given the key, return the first value of the property.
     *
     * @param key The key to lookup.
     * @return The first property value or null if it is not set or is missing.
     */
    public String getFirstPropertyValue(String key) {
        List values = getProperty(key);
        if (!values.isEmpty()) {
            return values.get(0);
        }
        return null;
    }
    
    public Set keySet() {
        if (props == null) {
            return null;
        }
        
        return props.keySet();
    }

    public void load(InputStream istream) throws IOException {
        String strLine;
        String key;
        String value;
        char firstChar;
        List valueList;
        int idxColon;
        int lineLength;

        BufferedReader br = new BufferedReader(new InputStreamReader(istream));
        //Read File Line By Line
        while ((strLine = br.readLine()) != null) {
            strLine = strLine.trim();
            lineLength = strLine.length();
            if (lineLength == 0) {
                continue;
            }

            firstChar = strLine.charAt(0);
            if (firstChar == '#' || firstChar == '!') {
                //comment line {
                continue;
            }

            idxColon = strLine.indexOf('=');
            if (idxColon == 0) {
                // "=foo"
                continue;
            }

            key = strLine.substring(0, idxColon).trim();
            value = strLine.substring(idxColon + 1).trim();

            valueList = props.get(key);
            if (valueList == null) {
                // the key is not in parameters yet
                valueList = new ArrayList();
                props.put(key, valueList);
            }
            valueList.add(value);
        }
        //Close the buffered reader
        br.close();
    }
    
    
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy