com.opengamma.strata.collect.io.CharSources.java Source code

Introduction

Here is the source code for com.opengamma.strata.collect.io.CharSources.java

Source

/*
 * Copyright (C) 2017 - present by OpenGamma Inc. and the OpenGamma group of companies
 *
 * Please see distribution for license.
 */
package com.opengamma.strata.collect.io;

import java.io.File;
import java.net.URL;
import java.nio.charset.Charset;
import java.nio.file.Path;

import com.google.common.base.Charsets;
import com.google.common.io.CharSource;
import com.google.common.io.Files;
import com.google.common.io.MoreFiles;
import com.google.common.io.Resources;

/**
 * Helper that allows {@code CharSource} objects to be created.
 */
public final class CharSources {

    private CharSources() {
    }

    /**
     * Obtains an instance of {@link CharSource} from a file name, specified as a String.
     *
     * @param fileName  the file name, as a String
     * @return  a new instance of {@link CharSource} with UTF-8 for charset.
     */
    public static CharSource ofFileName(String fileName) {
        return Files.asCharSource(new File(fileName), Charsets.UTF_8);
    }

    /**
     * Obtains an instance of {@link CharSource} from a file name, specified as a String.
     * This also takes in a specific character set, as a {@link Charset}.
     *
     * @param fileName  the file name, as a String
     * @param charset  the charset to build the new CharSource based on
     * @return  a new instance of {@link CharSource}
     */
    public static CharSource ofFileName(String fileName, Charset charset) {
        return Files.asCharSource(new File(fileName), charset);
    }

    //---------------------------------------------------------------------------------------------
    /**
     * Obtains an instance of {@link CharSource} from a file object, specified as a {@link File}.
     *
     * @param file  the file object
     * @return  a new instance of {@link CharSource} with UTF-8 for charset.
     */
    public static CharSource ofFile(File file) {
        return Files.asCharSource(file, Charsets.UTF_8);
    }

    /**
     * Obtains an instance of {@link CharSource} from a file object, specified as a {@link File}.
     * This also takes in a specific character set, as a {@link Charset}.
     *
     * @param file  the file object
     * @param charset  the charset to build the new CharSource based on
     * @return  a new instance of {@link CharSource}
     */
    public static CharSource ofFile(File file, Charset charset) {
        return Files.asCharSource(file, charset);
    }

    //---------------------------------------------------------------------------------------------
    /**
     * Obtains an instance of {@link CharSource} from a file path, specified as a {@link Path}.
     *
     * @param path  the path to create a {@link CharSource} from
     * @return  a new instance of {@link CharSource} with UTF-8 for charset.
     */
    public static CharSource ofPath(Path path) {
        return MoreFiles.asCharSource(path, Charsets.UTF_8);
    }

    /**
     * Obtains an instance of {@link CharSource} from a file path, specified as a {@link Path}.
     * This also takes in a specific character set, as a {@link Charset}.
     *
     * @param path  the path to create a {@link CharSource} from
     * @param charset  the charset to build the new CharSource based on
     * @return  a new instance of {@link CharSource}
     */
    public static CharSource ofPath(Path path, Charset charset) {
        return MoreFiles.asCharSource(path, charset);
    }

    //---------------------------------------------------------------------------------------------
    /**
     * Obtains an instance of {@link CharSource} from a URL, specified as a {@link URL} object.
     *
     * @param url  the url to create a {@link CharSource} from
     * @return  a new instance of {@link CharSource} with UTF-8 for charset.
     */
    public static CharSource ofUrl(URL url) {
        return Resources.asCharSource(url, Charsets.UTF_8);
    }

    /**
     * Obtains an instance of {@link CharSource} from an URL, specified as a {@link URL} object.
     * This also takes in a specific character set, as a {@link Charset}.
     *
     * @param url  the url to create a {@link CharSource} from
     * @param charset  the charset to build the new CharSource based on
     * @return  a new instance of {@link CharSource}.
     */
    public static CharSource ofUrl(URL url, Charset charset) {
        return Resources.asCharSource(url, charset);
    }

    //---------------------------------------------------------------------------------------------
    /**
     * Obtains an instance of {@link CharSource} from a text variable, specified as a {@link String} object.
     *
     * @param content  the text to create a {@link CharSource} for
     * @return  a new instance of {@link CharSource} with UTF-8 for charset
     */
    public static CharSource ofContent(String content) {
        return CharSource.wrap(content);
    }

    //---------------------------------------------------------------------------------------------
    /**
     * Obtains an instance of {@link CharSource} from a text variable, specified as a byte array.
     * 
     * @param content  the text to create a {@link CharSource} for
     * @return  a new instance of {@link CharSource} with UTF-8 for charset
     */
    public static CharSource ofContent(byte[] content) {
        return CharSource.wrap(new String(content, Charsets.UTF_8));
    }

    /**
     * Obtains an instance of {@link CharSource} from a text variable, specified as a byte array.
     * This also takes in a specific character set, as a {@link Charset}.
     * 
     * @param content  the text to create a {@link CharSource} for
     * @param charset  the charset to build the new CharSource based on
     * @return  a new instance of {@link CharSource}
     */
    public static CharSource ofContent(byte[] content, Charset charset) {
        return CharSource.wrap(new String(content, charset));
    }
}