nl.xs4all.home.freekdb.b52reader.general.Utilities.java Source code

Introduction

Here is the source code for nl.xs4all.home.freekdb.b52reader.general.Utilities.java

Source

/*
 * Project: B52 reader (https://github.com/FreekDB/b52-reader).
 * License: Apache version 2 (https://www.apache.org/licenses/LICENSE-2.0).
 */

package nl.xs4all.home.freekdb.b52reader.general;

import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintStream;
import java.net.URL;
import java.time.Month;
import java.time.ZoneOffset;
import java.time.ZonedDateTime;

import javax.swing.Icon;
import javax.swing.ImageIcon;

import nl.xs4all.home.freekdb.b52reader.browsers.BrowserFactory;
import nl.xs4all.home.freekdb.b52reader.browsers.EmbeddedBrowserType;
import nl.xs4all.home.freekdb.b52reader.browsers.JWebBrowserFactory;
import nl.xs4all.home.freekdb.b52reader.browsers.JxBrowserFactory;
import nl.xs4all.home.freekdb.b52reader.datamodel.Article;

import org.apache.commons.lang3.StringUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

/**
 * Utility methods for the entire application.
 *
 * @author <a href="mailto:fdbdbr@gmail.com">Freek de Bruijn</a>
 */
public class Utilities {
    /**
     * Logger for this class.
     */
    private static final Logger logger = LogManager.getLogger();

    /**
     * Factory for creating embedded web browser components.
     */
    private static BrowserFactory browserFactory;

    /**
     * Private constructor to hide the implicit public one, since this class is not meant to be instantiated.
     */
    private Utilities() {
        // Should not be called.
    }

    /**
     * Normalize a string by stripping all accents and converting it to lowercase.
     *
     * @param text the text to normalized.
     * @return the normalized version of text.
     */
    public static String normalize(final String text) {
        return text != null ? StringUtils.stripAccents(text).toLowerCase() : null;
    }

    /**
     * Estimate the number of words in a specific text.
     *
     * @param text text to estimate the word count for.
     * @return estimation of number of words in a text.
     */
    public static int estimateWordCount(final String text) {
        return text == null || text.trim().isEmpty() ? 0 : text.trim().split("\\s+").length;
    }

    /**
     * Get an icon from a specific resource file.
     *
     * @param iconFileName file name of icon resource.
     * @return icon from a resource file.
     */
    public static Icon getIconResource(final String iconFileName) {
        final URL iconFileUrl = Utilities.class.getClassLoader().getResource(iconFileName);

        return (iconFileUrl != null) ? new ImageIcon(iconFileUrl.getFile()) : null;
    }

    /**
     * Create a string with a specific count, a space, and a specific word. If count is not equal to one, an 's'
     * character is added to the word. Some examples: "0 bikes", "1 programmer", and "6 guitarists".
     *
     * @param count number of times that applies to the word.
     * @param word  word to include in the string (the plural form should require the addition of an 's' character).
     * @return "[count] [word](s)" (if count is not equal to one, an 's' character is added).
     */
    public static String countAndWord(final int count, final String word) {
        return count + " " + word + (count != 1 ? "s" : "");
    }

    /**
     * Create a zoned date(/time). The time part is empty.
     *
     * @param year       year.
     * @param month      month.
     * @param dayOfMonth day of the month.
     * @return <code>ZonedDateTime</code> object.
     */
    public static ZonedDateTime createDate(final int year, final Month month, final int dayOfMonth) {
        return ZonedDateTime.of(year, month.getValue(), dayOfMonth, 0, 0, 0, 0, ZoneOffset.UTC);
    }

    /**
     * Ignore characters written to the standard error stream. This is used because the dj-nativeswing library sometimes
     * has difficulties with the contents of the clipboard, resulting in <code>ClassNotFoundException</code>s.
     */
    public static void ignoreStandardErrorStream() {
        // Ignore characters written to the standard error stream, since the dj-nativeswing library sometimes has
        // difficulties with the contents of the clipboard, resulting in ClassNotFoundException-s.
        try (OutputStream outputStream = getIgnorantStream()) {
            System.setErr(new PrintStream(outputStream, false, "UTF-8"));
        } catch (final IOException e) {
            logger.error("Exception while redirecting the standard error stream.", e);
        }
    }

    /**
     * Create an output stream that ignores everything that is written to it.
     *
     * @return an output stream that ignores everything.
     */
    private static OutputStream getIgnorantStream() {
        return new OutputStream() {
            @Override
            public void write(final int b) throws IOException {
                // Ignore it.
            }
        };
    }

    /**
     * If there is previous data available for this article, copy the fields that are managed by the B52 reader.
     *
     * @param article         the new article.
     * @param previousArticle the previous article (or null if not available).
     */
    public static void copyPreviousDataIfAvailable(final Article article, final Article previousArticle) {
        if (previousArticle != null) {
            article.setStarred(previousArticle.isStarred());
            article.setRead(previousArticle.isRead());
            article.setArchived(previousArticle.isArchived());
        }
    }

    /**
     * Get factory for creating embedded web browser components, based on <code>Constants.EMBEDDED_BROWSER_TYPE</code>
     * setting.
     *
     * @return factory for creating embedded web browser components.
     */
    public static BrowserFactory getBrowserFactory() {
        if (browserFactory == null) {
            if (Constants.EMBEDDED_BROWSER_TYPE == EmbeddedBrowserType.EMBEDDED_BROWSER_JX_BROWSER) {
                browserFactory = new JxBrowserFactory();
            } else {
                browserFactory = new JWebBrowserFactory();
            }
        }

        return browserFactory;
    }
}