com.jirvan.dates.Millisecond Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ji-utils Show documentation
A general java utilities library
The newest version!
/*

Copyright (c) 2012, Jirvan Pty Ltd
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted 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 Jirvan Pty Ltd nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.

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 OWNER OR CONTRIBUTORS BE LIABLE 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 com.jirvan.dates;

import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.TimeZone;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * This class is primarily here to get around the standard java Date class's
 * entanglement with timezone.  It is mainly for using with dates that have no
 * need for association with a time zone.  The association of a time zone can
 * actually cause real problems in these situations.  For example if a persons
 * birthday is the first of May, then it is always the 1st of May regardless of
 * what timezone they were born in or where they are now.  At the moment a
 * Gregorian calendar is assumed.
 */
public class Millisecond {

    private int year;
    private int monthInYear;
    private int dayInMonth;
    private int hourInDay;
    private int minuteInHour;
    private int secondInMinute;
    private int millisecondInSecond;

    public Millisecond() {
        this(new Date());
    }

    public Millisecond(int year, int monthInYear, int dayInMonth, int hourInDay, int minuteInHour, int secondInMinute, int millisecondInSecond) {
        this.year = year;
        this.monthInYear = monthInYear;
        this.dayInMonth = dayInMonth;
        this.hourInDay = hourInDay;
        this.minuteInHour = minuteInHour;
        this.secondInMinute = secondInMinute;
        this.millisecondInSecond = millisecondInSecond;
    }

    private Millisecond(GregorianCalendar calendar) {
        this.year = calendar.get(GregorianCalendar.YEAR);
        this.monthInYear = calendar.get(GregorianCalendar.MONTH) + 1;
        this.dayInMonth = calendar.get(GregorianCalendar.DAY_OF_MONTH);
        this.hourInDay = calendar.get(GregorianCalendar.HOUR_OF_DAY);
        this.minuteInHour = calendar.get(GregorianCalendar.MINUTE);
        this.secondInMinute = calendar.get(GregorianCalendar.SECOND);
        this.millisecondInSecond = calendar.get(GregorianCalendar.MILLISECOND);
    }

    private Millisecond(Date date) {
        GregorianCalendar calendar = new GregorianCalendar();
        calendar.setTime(date);
        this.year = calendar.get(GregorianCalendar.YEAR);
        this.monthInYear = calendar.get(GregorianCalendar.MONTH) + 1;
        this.dayInMonth = calendar.get(GregorianCalendar.DAY_OF_MONTH);
        this.hourInDay = calendar.get(GregorianCalendar.HOUR_OF_DAY);
        this.minuteInHour = calendar.get(GregorianCalendar.MINUTE);
        this.secondInMinute = calendar.get(GregorianCalendar.SECOND);
        this.millisecondInSecond = calendar.get(GregorianCalendar.MILLISECOND);
    }

    public Millisecond(Date date, TimeZone timeZone) {
        GregorianCalendar calendar = new GregorianCalendar(timeZone);
        calendar.setTime(date);
        this.year = calendar.get(GregorianCalendar.YEAR);
        this.monthInYear = calendar.get(GregorianCalendar.MONTH) + 1;
        this.dayInMonth = calendar.get(GregorianCalendar.DAY_OF_MONTH);
        this.hourInDay = calendar.get(GregorianCalendar.HOUR_OF_DAY);
        this.minuteInHour = calendar.get(GregorianCalendar.MINUTE);
        this.secondInMinute = calendar.get(GregorianCalendar.SECOND);
        this.millisecondInSecond = calendar.get(GregorianCalendar.MILLISECOND);
    }

    public static Millisecond now() {
        return new Millisecond();
    }

    public int getYear() {
        return year;
    }

    public Millisecond setYear(int year) {
        this.year = year;
        return this;
    }

    public int getMonthInYear() {
        return monthInYear;
    }

    public Millisecond setMonthInYear(int monthInYear) {
        this.monthInYear = monthInYear;
        return this;
    }

    public int getDayInMonth() {
        return dayInMonth;
    }

    public Millisecond setDayInMonth(int dayInMonth) {
        this.dayInMonth = dayInMonth;
        return this;
    }

    public int getHourInDay() {
        return hourInDay;
    }

    public Millisecond setHourInDay(int hourInDay) {
        this.hourInDay = hourInDay;
        return this;
    }

    public int getMinuteInHour() {
        return minuteInHour;
    }

    public Millisecond setMinuteInHour(int minuteInHour) {
        this.minuteInHour = minuteInHour;
        return this;
    }

    public int getSecondInMinute() {
        return secondInMinute;
    }

    public Millisecond setSecondInMinute(int secondInMinute) {
        this.secondInMinute = secondInMinute;
        return this;
    }

    public int getMillisecondInSecond() {
        return millisecondInSecond;
    }

    public Millisecond setMillisecondInSecond(int millisecondInSecond) {
        this.millisecondInSecond = millisecondInSecond;
        return this;
    }

    public Date getDate() {
        return getCalendar().getTime();
    }

    public Calendar getCalendar() {
        GregorianCalendar calendar = new GregorianCalendar();
        calendar.set(year, monthInYear - 1, dayInMonth, hourInDay, minuteInHour, secondInMinute);
        calendar.set(GregorianCalendar.MILLISECOND, millisecondInSecond);
        return calendar;
    }

    public Month getMonth() {
        return new Month(year, monthInYear);
    }

    public Day getDay() {
        return new Day(year, monthInYear, dayInMonth);
    }

    public Hour getHour() {
        return new Hour(year, monthInYear, dayInMonth, hourInDay);
    }

    public Minute getMinute() {
        return new Minute(year, monthInYear, dayInMonth, hourInDay, minuteInHour);
    }

    public Second getSecond() {
        return new Second(year, monthInYear, dayInMonth, hourInDay, minuteInHour, secondInMinute);
    }

    public Millisecond next() {
        return advanced(1);
    }

    public Millisecond previous() {
        return advanced(-1);
    }

    public Millisecond advanced(int milliseconds) {
        GregorianCalendar calendar = new GregorianCalendar();
        calendar.set(year, monthInYear - 1, dayInMonth, hourInDay, minuteInHour, secondInMinute);
        calendar.set(GregorianCalendar.MILLISECOND, millisecondInSecond);
        calendar.add(GregorianCalendar.MILLISECOND, milliseconds);
        return new Millisecond(calendar);
    }

    @Override
    public boolean equals(Object obj) {
        return obj != null
               && obj instanceof Millisecond
               && ((Millisecond) obj).getYear() == year
               && ((Millisecond) obj).getMonthInYear() == monthInYear
               && ((Millisecond) obj).getDayInMonth() == dayInMonth
               && ((Millisecond) obj).getHourInDay() == hourInDay
               && ((Millisecond) obj).getMinuteInHour() == minuteInHour
               && ((Millisecond) obj).getSecondInMinute() == secondInMinute
               && ((Millisecond) obj).getMillisecondInSecond() == millisecondInSecond;
    }

    public String toString() {
        return String.format("%04d-%02d-%02d %02d:%02d:%02d.%03d", year, monthInYear, dayInMonth, hourInDay, minuteInHour, secondInMinute, millisecondInSecond);
    }

    public String toFilenameSafeString() {
        return String.format("%04d%02d%02d-%02d%02d-%02d.%03d", year, monthInYear, dayInMonth, hourInDay, minuteInHour, secondInMinute, millisecondInSecond);
    }

    public static Millisecond fromString(String string) {
        if (string == null) {
            return null;
        } else {
            Matcher m = Pattern.compile("^(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)[ T](\\d\\d):(\\d\\d):(\\d\\d).(\\d\\d?\\d?)$").matcher(string);
            if (!m.matches()) {
                throw new MillisecondTimestampFormatException(string);
            }
            int year = Integer.parseInt(m.group(1));
            int month = Integer.parseInt(m.group(2));
            int day = Integer.parseInt(m.group(3));
            int hour = Integer.parseInt(m.group(4));
            int minute = Integer.parseInt(m.group(5));
            int second = Integer.parseInt(m.group(6));
            int millisecond = Integer.parseInt(m.group(7));
            return new Millisecond(year, month, day, hour, minute, second, millisecond);
        }
    }

    public static Millisecond from(Date date) {
        if (date == null) {
            return null;
        } else {
            return new Millisecond(date);
        }
    }

    public static Date toDate(Millisecond millisecond) {
        if (millisecond == null) {
            return null;
        } else {
            return millisecond.getDate();
        }
    }

    public static Millisecond from(GregorianCalendar calendar) {
        if (calendar == null) {
            return null;
        } else {
            return new Millisecond(calendar);
        }
    }

    public static Calendar toCalendar(Millisecond millisecond) {
        if (millisecond == null) {
            return null;
        } else {
            return millisecond.getCalendar();
        }
    }

    public String format(String pattern) {
        return new SimpleDateFormat(pattern).format(getDate());
    }

    public static String format(Millisecond millisecond, String pattern) {
        return format(millisecond, pattern, null);
    }

    public static String format(Millisecond millisecond, String pattern, String valueIfNull) {
        return millisecond == null ? valueIfNull : new SimpleDateFormat(pattern).format(millisecond.getDate());
    }

    public static String formatDuration(Millisecond from, Millisecond to) {
        if (from == null || to == null) {
            return "";
        } else {
            return formatDuration(to.getDate().getTime() - from.getDate().getTime());
        }
    }

    public static String formatDuration(Long milliseconds) {
        if (milliseconds == null) {
            return "";
        } else {
            long totalMilliseconds = Math.abs(milliseconds);
            long totalSeconds = totalMilliseconds / 1000;
            long totalMinutes = totalMilliseconds / (60 * 1000);
            long hoursComponent = totalMilliseconds / (60 * 60 * 1000);
            long minutesComponent = totalMinutes - (hoursComponent * 60);
            long secondsComponent = totalSeconds - (totalMinutes * 60);
            long millisecondsComponent = totalMilliseconds - (totalSeconds * 1000);
            return String.format("%s%02d:%02d:%02d.%03d", milliseconds < 0 ? "-" : "", hoursComponent, minutesComponent, secondsComponent, millisecondsComponent);
        }
    }

}