uk.theretiredprogrammer.nbpcglibrary.api.DateOnly Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
APIs for the modules generated using the NetBeans Platform Code Generator(NBPCG)
The newest version!
/*
 * Copyright 2014-2017 Richard Linsdale.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package uk.theretiredprogrammer.nbpcglibrary.api;

import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * Simple Date Only Class
 *
 * @author Richard Linsdale (richard at theretiredprogrammer.uk)
 */
public class DateOnly {

    private final static DateFormat sqlformat = new SimpleDateFormat("yyyyMMdd");
    private final static DateFormat userformat = new SimpleDateFormat("dd-MMM-yyyy");
    private Date date;

    /**
     * Constructor
     */
    public DateOnly() {
        date = new Date();
    }

    /**
     * Constructor
     *
     * @param datestring the initial value of the timestamp (formatted in
     * display format ("dd-MMM-yyyy"))
     * @throws BadFormatException if datastring is badly formatted
     */
    public DateOnly(String datestring) throws BadFormatException {
        userformat.setLenient(true);
        try {
            date = userformat.parse(datestring);
        } catch (ParseException ex) {
            throw new BadFormatException("Bad entry format - expected a date (dd-MMM-yyyy)");
        }
    }

    /**
     * Set the date using an SQL formatted datestring ("yyyyMMddH")
     *
     * @param sqlstring the value (formatted in SQL format)
     * @throws BadFormatException when when sqlstring is badly formatted
     */
    public void setDateUsingSQLString(String sqlstring) throws BadFormatException {
        sqlformat.setLenient(false);
        try {
            date = sqlformat.parse(sqlstring);
        } catch (ParseException ex) {
            throw new BadFormatException("DateOnly:setDateUsinSQLString() - Illegal sqlstring format");
        }
    }

    /**
     * Get the SQl formated date (yyyyMMdd)
     *
     * @return the formatted date
     */
    public String toSQLString() {
        return sqlformat.format(date);
    }

    /**
     * Get the display formatted date (dd-MMM-yyyy)
     *
     * @return the formatted date
     */
    @Override
    public String toString() {
        return userformat.format(date);
    }

    /**
     * Compare this date to the current date.
     *
     * @return +1 / 0 / -1 depending on result of compare
     */
    public int compareTo() {
        return compareTo(new DateOnly());
    }

    /**
     * compare
     *
     * returns 1 if this date is greater that the target date; 0 if they are the
     * same and -1 if less that the target date
     *
     * @param target the target date
     * @return +1 / 0 / -1 depending on result of compare
     */
    public int compareTo(DateOnly target) {
        return toSQLString().compareTo(target.toSQLString());
    }
}