com.acmutv.ontoqa.tool.io.IOManager.java Source code

Introduction

Here is the source code for com.acmutv.ontoqa.tool.io.IOManager.java

Source

/*
  The MIT License (MIT)
    
  Copyright (c) 2016 Antonella Botte, Giacomo Marciani and Debora Partigianoni
    
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
    
    
  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.
    
    
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  THE SOFTWARE.
 */

package com.acmutv.ontoqa.tool.io;

import org.apache.commons.io.IOUtils;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URL;
import java.nio.charset.Charset;
import java.nio.file.*;
import java.util.ArrayList;
import java.util.List;

/**
 * This class realizes I/O services.
 * @author Antonella Botte {@literal <abotte@acm.org>}
 * @author Giacomo Marciani {@literal <gmarciani@acm.org>}
 * @author Debora Partigianoni {@literal <dpartigianoni@acm.org>}
 * @since 1.0
 */
public class IOManager {

    /**
     * Returns an {@link InputStream} from a general resource.
     * @param resource the resource locator (e.g.: path for local file, http url for remote file).
     * @return the open {@link InputStream}.
     * @throws IOException when the {@link InputStream} cannot be opened.
     */
    public static InputStream getInputStream(final String resource) throws IOException {
        if (resource.startsWith("http://") || resource.startsWith("https://")) {
            final URL url = new URL(resource);
            return url.openStream();
        } else {
            final Path path = FileSystems.getDefault().getPath(resource).toAbsolutePath();
            return Files.newInputStream(path);
        }
    }

    /**
     * Returns an {@link OutputStream} from a general resource.
     * @param resource the resource locator (e.g.: path for local file, http url for remote file).
     * @return the open {@link OutputStream}.
     * @throws IOException when the {@link OutputStream} cannot be opened.
     */
    public static OutputStream getOutputStream(final String resource) throws IOException {
        final Path path = FileSystems.getDefault().getPath(resource).toAbsolutePath();
        return Files.newOutputStream(path);
    }

    /**
     * Checks if a resource is writable.
     * @param resource the resource to check.
     * @return true if the resource is writable; false, otherwise.
     */
    public static boolean isWritableResource(String resource) {
        final Path path = FileSystems.getDefault().getPath(resource).toAbsolutePath();
        return Files.isWritable(path);
    }

    /**
     * Reads a resource.
     * @param resource the resource to read.
     * @return the string read.
     * @throws IOException when resource cannot be read.
     */
    public static String readResource(String resource) throws IOException {
        String string;
        try (final InputStream in = getInputStream(resource)) {
            string = IOUtils.toString(in, Charset.defaultCharset());
        }
        return string;
    }

    /**
     * Write on a resource.
     * @param resource the resource to write on.
     * @param  string the string to write.
     * @throws IOException when resource cannot be read.
     */
    public static void writeResource(String resource, String string) throws IOException {
        try (final OutputStream out = getOutputStream(resource)) {
            IOUtils.write(string, out, Charset.defaultCharset());
        }
    }

    /**
     * Appends string on a resource.
     * @param resource the resource to write on.
     * @param string the string to write.
     * @throws IOException when resource cannot be written.
     */
    public static void appendResource(String resource, String string) throws IOException {
        Path path = FileSystems.getDefault().getPath(resource).toAbsolutePath();
        Files.write(path, string.getBytes(), StandardOpenOption.APPEND);
    }

    /**
     * Checks if {@code resource} is a directory.
     * @param resource the resource to check.
     * @return true if {@code resource} is a directory; else, otherwise.
     */
    public static boolean isDirectory(String resource) {
        final Path path = FileSystems.getDefault().getPath(resource).toAbsolutePath();
        return Files.isDirectory(path);
    }

    /**
     * Checks if {@code resource} is a regular file.
     * @param resource the resource to check.
     * @return true if {@code resource} is a regular file; else, otherwise.
     */
    public static boolean isFile(String resource) {
        final Path path = FileSystems.getDefault().getPath(resource).toAbsolutePath();
        return Files.isRegularFile(path);
    }

    /**
     * Returns the list of all files inside {@code directory}.
     * @param directory the directory to inspect.
     * @return the list of all files inside {@code directory}.
     * @throws IOException when files cannot be listed in {@code directory}.
     */
    public static List<Path> allFiles(String directory) throws IOException {
        List<Path> files = new ArrayList<>();
        try (DirectoryStream<Path> directoryStream = Files.newDirectoryStream(Paths.get(directory))) {
            directoryStream.forEach(f -> {
                if (Files.isRegularFile(f))
                    files.add(f);
            });
        }
        return files;
    }

    /**
     * Returns the list of all files inside {@code directory}.
     * @param directory the directory to inspect.
     * @param matcher the file pattern matching.
     * @return the list of all files inside {@code directory}.
     * @throws IOException when files cannot be listed in {@code directory}.
     */
    public static List<Path> allFiles(String directory, String matcher) throws IOException {
        List<Path> files = new ArrayList<>();
        try (DirectoryStream<Path> directoryStream = Files.newDirectoryStream(Paths.get(directory), matcher)) {
            directoryStream.forEach(f -> {
                if (Files.isRegularFile(f))
                    files.add(f);
            });
        }
        return files;
    }
}