All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • t3.utils.SortedProperties Maven / Gradle / Ivy

    The newest version!
    /**
 * (C) Copyright 2016-2019 teecube
 * (https://teecu.be) and others.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package t3.utils;

import org.apache.commons.io.FileUtils;
import org.apache.maven.model.Resource;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.shared.filtering.MavenResourcesExecution;
import t3.CommonMojo;

import java.io.*;
import java.math.BigInteger;
import java.util.*;

/**
 * 
    
 * This class extends java.util.Properties with all properties sorted alphabetically. Also, the setProperty method is
 * overridden to support multiple input types and check for null values.
 * 
    
 *
 * @author Mathieu Debove <[email protected]>
 *
 */
public class SortedProperties extends Properties {
    private static final long serialVersionUID = 3733070302160913988L;

    @Override
    public synchronized Enumeration keys() {
        return Collections.enumeration(new TreeSet(super.keySet()));
    }

    @Override
    public synchronized Object setProperty(String key, String value) {
        if (value != null) {
            return super.setProperty(key, value);
        }
        return null;
    }

    public synchronized Object setProperty(String key, BigInteger value) {
        if (value != null) {
            return super.setProperty(key, value.toString());
        }
        return null;
    }

    public synchronized Object setProperty(String key, Boolean value) {
        if (value != null) {
            return super.setProperty(key, value.toString());
        }
        return null;
    }

    /**
     * 
    
     * This loads a properties file into a java.util.Properties object with
     * sorted keys.

    
     *
     *  NB: always use keys() method to browse the properties
     * 
    
     *
     * @param propertiesFile
     * @return
     * @throws IOException
     */
    public static Properties loadPropertiesFile(File propertiesFile, String encoding) throws IOException {
        Properties properties = new SortedProperties();

        FileInputStream fileInputStream = new FileInputStream(propertiesFile);
        Reader reader = new InputStreamReader(fileInputStream, encoding);
        properties.load(reader);

        return properties;
    }

    /**
     * 
    
     * This saves a java.util.Properties to a file.
    
     *
     * It is possible to add a comment at the beginning of the file.
     * 
    
     *
     * @param outputFile, the File where to output the Properties
     * @param properties, the Properties to save
     * @param propertiesComment, the comment to add at the beginning of the file
     * @param success, the success message
     * @param failure, the failure message
     * @throws MojoExecutionException
     */
    public static void savePropertiesToFile(File outputFile, Properties properties, String encoding,
                                        String propertiesComment, String success, String failure, Boolean filterProperties,
                                        CommonMojo mojo)
                                        throws MojoExecutionException {
        OutputStream outputStream = null;

        try {
            outputFile.getParentFile().mkdirs();
            outputStream = new FileOutputStream(outputFile);
            OutputStreamWriter outputStreamWriter = new OutputStreamWriter(outputStream, encoding);
            properties.store(outputStreamWriter, propertiesComment);

            if (filterProperties) {
                mojo.getLog().debug("Filtering properties files");

                File tmpDir = new File(outputFile.getParentFile(), "tmp");
                tmpDir.mkdir();
                List resources = new ArrayList();
                Resource r = new Resource();
                r.setDirectory(outputFile.getParentFile().getAbsolutePath());
                r.addInclude("*.properties");
                r.setFiltering(true);
                resources.add(r);

                List filters = new ArrayList();
                List nonFilteredFileExtensions = new ArrayList();

                MavenResourcesExecution mre = new MavenResourcesExecution(resources, tmpDir, mojo.getProject(), mojo.getSourceEncoding(), filters, nonFilteredFileExtensions, mojo.getSession());
                mojo.getMavenResourcesFiltering().filterResources(mre);

                FileUtils.copyDirectory(tmpDir, outputFile.getParentFile());
                FileUtils.deleteDirectory(tmpDir);
            }

            mojo.getLog().info(success + " '" + outputFile + "'");
        } catch (Exception e) {
            throw new MojoExecutionException(failure + " '" + outputFile + "'", e);
        } finally {
            try {
                outputStream.close();
            } catch (Exception e) {
            }
        }
    }

    /**
     * 
    
     * This method sorts a {@link Properties} object.
     * 
    
     *
     * @param properties
     * @return
     */
    public static Properties sortProperties(Properties properties) {
        Properties sp = new SortedProperties();
        sp.putAll(properties);

        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        try {
            sp.store(baos, null);
            properties.clear();
            properties.load(new ByteArrayInputStream(baos.toByteArray()));
        } catch (IOException e) {
            // was not sorted
        }

        return properties;
    }

}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy