org.cactoos.time.DateAsText Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cactoos Show documentation
Object-oriented Java Primitives
There is a newer version: 0.56.1
/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2017-2018 Yegor Bugayenko
 *
 * 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 NON-INFRINGEMENT. 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 org.cactoos.time;

import java.time.Instant;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.time.format.DateTimeFormatter;
import java.util.Date;
import java.util.Locale;
import org.cactoos.Text;

/**
 * Formatter for {@link Date} instances.
 * @since 0.27
 */
@SuppressWarnings("PMD.AvoidDuplicateLiterals")
public final class DateAsText implements Text {

    /**
     * Internal text carrying the formatted date.
     */
    private final ZonedDateTimeAsText text;

    /**
     * Formats current time using the ISO format.
     */
    public DateAsText() {
        this(System.currentTimeMillis());
    }

    /**
     * Formats the milliseconds using the ISO format.
     * @param milliseconds Milliseconds to format.
     */
    public DateAsText(final long milliseconds) {
        this(
            Date.from(Instant.ofEpochMilli(milliseconds)),
            new Iso().get()
        );
    }

    /**
     * Formats the milliseconds using the format and the default locale.
     * @param milliseconds Milliseconds to format.
     * @param format The format to use.
     */
    public DateAsText(final long milliseconds, final String format) {
        this(
            Date.from(Instant.ofEpochMilli(milliseconds)), format,
            Locale.getDefault(Locale.Category.FORMAT)
        );
    }

    /**
     * Formats the milliseconds as date using the format and the locale.
     * @param milliseconds Milliseconds to format as date.
     * @param format The format to use.
     * @param locale The locale to use for the format.
     */
    public DateAsText(final long milliseconds, final String format,
        final Locale locale) {
        this(
            Date.from(Instant.ofEpochMilli(milliseconds)),
            DateTimeFormatter.ofPattern(format, locale)
        );
    }

    /**
     * Formats the date with ISO format using the system zone.
     * @param date The date to format.
     */
    public DateAsText(final Date date) {
        this(date, new Iso().get());
    }

    /**
     * Formats the date with to format using the default locale and the system
     * zone.
     * @param date The date to format.
     * @param format The format to use.
     */
    public DateAsText(final Date date, final String format) {
        this(date, format, Locale.getDefault(Locale.Category.FORMAT));
    }

    /**
     * Formats the date using the format and locale using the system default
     * zone.
     * @param date The date to format.
     * @param format The format to use.
     * @param locale The locale to use.
     */
    public DateAsText(final Date date, final String format,
        final Locale locale) {
        this(date, DateTimeFormatter.ofPattern(format, locale));
    }

    /**
     * Formats the date using the format and locale using the system default
     * zone.
     * @param date The date to format.
     * @param formatter The formatter to use.
     */
    public DateAsText(final Date date, final DateTimeFormatter formatter) {
        this.text = new ZonedDateTimeAsText(
            ZonedDateTime.ofInstant(date.toInstant(), ZoneId.of("UTC")),
            formatter
        );
    }

    @Override
    public String asString() {
        return this.text.asString();
    }

}