de.invation.code.toval.os.OSUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of TOVAL Show documentation

TOVAL comprises a set of java classes for common programming issues. It includes utils for arrays, lists, sets and collections for convenient handling and modification, but also support for mathematic definitions concerning logic (clauses + resolution) together with some algorithms for permutations, powersets and resolution. Additionally it contains a number of types for multisets, matrices with object keys and much more.

The newest version!

/*
 * Copyright (c) 2015, Thomas Stocker
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted (subject to the limitations in the disclaimer
 * below) provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * * Neither the name of IIG Telematics, Uni Freiburg nor the names of its
 *   contributors may be used to endorse or promote products derived from this
 *   software without specific prior written permission.
 *
 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
 * THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BELIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package de.invation.code.toval.os;

import java.io.File;
import java.net.URISyntaxException;
import java.util.regex.Pattern;

/**
 * Utils class regarding operating system functionalities and properties.
 *
 * @version 1.0
 * @author Adrian Lange 
 */
public abstract class OSUtils {

    public final static Pattern MIME_PATTERN = Pattern.compile("[a-zA-Z]+\\/[a-zA-Z0-9\\+-\\.]+");

    /**
     * Returns the current operating system
     *
     * @return Operating system of type {@link OSType}
     */
    public static OSType getCurrentOS() {
        String osName = System.getProperty("os.name");
        return OSType.getOSTypeByName(osName);
    }

    /**
     * Returns the execution path to the direcory of the current Java
     * application.
     *
     * @return Execution path as {@link File}.
     * @throws OSException If the execution path can't be determined.
     */
    public static File getExecutionPath() throws OSException {
        try {
            return new File(OSUtils.class.getProtectionDomain().getCodeSource().getLocation().toURI().getPath());
        } catch (URISyntaxException ex) {
            throw new OSException(ex);
        }
    }
    
    /**
     * Returns the associated application for a given extension.
     *
     * @param fileTypeExtension File extension with leading dot, e.g.
     * .bar.
     * @return {@link String} with path to associated application or
     * null if file extension is not registered or can't be read.
     * @throws OSException
     */
    public abstract String getFileExtension(String fileTypeExtension) throws OSException;

    /**
     * Returns the version of the JVM
     *
     * @return Java specification version
     */
    public static String getJavaVersion() {
        return System.getProperty("java.specification.version");
    }

    /**
     * Returns the current user's home directory.
     *
     * @return The home directory as {@link File}
     */
    public static File getUserHomeDirectory() {
        return new File(System.getProperty("user.home"));
    }

    /**
     * Returns true if this class type fits the operating system,
     * otherwise false.
     *
     * @return Boolean value if class is applicable.
     */
    public abstract boolean isApplicable();
    
    /**
     * Checks if the given extension is already registered.
     *
     * @param fileTypeExtension File extension with leading dot, e.g.
     * .bar.
     * @return true if extension is registered, false
     * otherwise.
     * @throws OSException
     */
    public abstract boolean isFileExtensionRegistered(String fileTypeExtension) throws OSException;

    /**
     * Registers a new file extension in the Windows registry.
     *
     * @param fileTypeName Name of the file extension. Must be atomic, e.g.
     * foocorp.fooapp.v1.
     * @param fileTypeExtension File extension with leading dot, e.g.
     * .bar.
     * @param application Path to the application, which should open the new
     * file extension.
     * @return true if registration was successful,
     * false otherwise.
     * @throws OSException
     */
    public abstract boolean registerFileExtension(String fileTypeName, String fileTypeExtension, String application) throws OSException;
}