Returns the number of minutes within the fragment. : Date Calculation « Data Type « Java






Returns the number of minutes within the fragment.

     
import java.util.Calendar;
import java.util.Date;
import java.util.Iterator;
import java.util.TimeZone;


/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */




/**
 * <p>A suite of utilities surrounding the use of the
 * {@link java.util.Calendar} and {@link java.util.Date} object.</p>
 * 
 * <p>DateUtils contains a lot of common methods considering manipulations
 * of Dates or Calendars. Some methods require some extra explanation.
 * The truncate and round methods could be considered the Math.floor(),
 * Math.ceil() or Math.round versions for dates
 * This way date-fields will be ignored in bottom-up order.
 * As a complement to these methods we've introduced some fragment-methods.
 * With these methods the Date-fields will be ignored in top-down order.
 * Since a date without a year is not a valid date, you have to decide in what
 * kind of date-field you want your result, for instance milliseconds or days.
 * </p>
 *   
 *   
 *
 * @author <a href="mailto:sergek@lokitech.com">Serge Knystautas</a>
 * @author Stephen Colebourne
 * @author Janek Bogucki
 * @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
 * @author Phil Steitz
 * @author Robert Scholte
 * @since 2.0
 * @version $Id: DateUtils.java 634096 2008-03-06 00:58:11Z niallp $
 */
public class Main {
  
  /**
   * The UTC time zone  (often referred to as GMT).
   */
  public static final TimeZone UTC_TIME_ZONE = TimeZone.getTimeZone("GMT");
  /**
   * Number of milliseconds in a standard second.
   * @since 2.1
   */
  public static final long MILLIS_PER_SECOND = 1000;
  /**
   * Number of milliseconds in a standard minute.
   * @since 2.1
   */
  public static final long MILLIS_PER_MINUTE = 60 * MILLIS_PER_SECOND;
  /**
   * Number of milliseconds in a standard hour.
   * @since 2.1
   */
  public static final long MILLIS_PER_HOUR = 60 * MILLIS_PER_MINUTE;
  /**
   * Number of milliseconds in a standard day.
   * @since 2.1
   */
  public static final long MILLIS_PER_DAY = 24 * MILLIS_PER_HOUR;

  /**
   * This is half a month, so this represents whether a date is in the top
   * or bottom half of the month.
   */
  public final static int SEMI_MONTH = 1001;

  private static final int[][] fields = {
          {Calendar.MILLISECOND},
          {Calendar.SECOND},
          {Calendar.MINUTE},
          {Calendar.HOUR_OF_DAY, Calendar.HOUR},
          {Calendar.DATE, Calendar.DAY_OF_MONTH, Calendar.AM_PM 
              /* Calendar.DAY_OF_YEAR, Calendar.DAY_OF_WEEK, Calendar.DAY_OF_WEEK_IN_MONTH */
          },
          {Calendar.MONTH, DateUtils.SEMI_MONTH},
          {Calendar.YEAR},
          {Calendar.ERA}};

  /**
   * A week range, starting on Sunday.
   */
  public final static int RANGE_WEEK_SUNDAY = 1;

  /**
   * A week range, starting on Monday.
   */
  public final static int RANGE_WEEK_MONDAY = 2;

  /**
   * A week range, starting on the day focused.
   */
  public final static int RANGE_WEEK_RELATIVE = 3;

  /**
   * A week range, centered around the day focused.
   */
  public final static int RANGE_WEEK_CENTER = 4;

  /**
   * A month range, the week starting on Sunday.
   */
  public final static int RANGE_MONTH_SUNDAY = 5;

  /**
   * A month range, the week starting on Monday.
   */
  public final static int RANGE_MONTH_MONDAY = 6;
  

  
  /**
   * <p>Returns the number of minutes within the 
   * fragment. All datefields greater than the fragment will be ignored.</p> 
   * 
   * <p>Asking the minutes of any date will only return the number of minutes
   * of the current hour (resulting in a number between 0 and 59). This 
   * method will retrieve the number of minutes for any fragment. 
   * For example, if you want to calculate the number of minutes past this month, 
   * your fragment is Calendar.MONTH. The result will be all minutes of the 
   * past day(s) and hour(s).</p> 
   * 
   * <p>Valid fragments are: Calendar.YEAR, Calendar.MONTH, both 
   * Calendar.DAY_OF_YEAR and Calendar.DATE, Calendar.HOUR_OF_DAY, 
   * Calendar.MINUTE, Calendar.SECOND and Calendar.MILLISECOND
   * A fragment less than or equal to a MINUTE field will return 0.</p> 
   * 
   * <p>
   * <ul>
   *  <li>January 1, 2008 7:15:10.538 with Calendar.HOUR_OF_DAY as fragment will return 15
   *   (equivalent to deprecated date.getMinutes())</li>
   *  <li>January 6, 2008 7:15:10.538 with Calendar.HOUR_OF_DAY as fragment will return 15
   *   (equivalent to deprecated date.getMinutes())</li>
   *  <li>January 1, 2008 7:15:10.538 with Calendar.MONTH as fragment will return 15</li>
   *  <li>January 6, 2008 7:15:10.538 with Calendar.MONTH as fragment will return 435 (7*60 + 15)</li>
   *  <li>January 16, 2008 7:15:10.538 with Calendar.MILLISECOND as fragment will return 0
   *   (a millisecond cannot be split in minutes)</li>
   * </ul>
   * </p>
   * 
   * @param date the date to work with, not null
   * @param fragment the Calendar field part of date to calculate 
   * @return number of minutes within the fragment of date
   * @throws IllegalArgumentException if the date is <code>null</code> or 
   * fragment is not supported
   * @since 2.4
   */
  public static long getFragmentInMinutes(Date date, int fragment) {
      return getFragment(date, fragment, Calendar.MINUTE);
  }
  
  
  /**
   * Date-version for fragment-calculation in any unit
   * 
   * @param date the date to work with, not null
   * @param fragment the Calendar field part of date to calculate 
   * @param unit Calendar field defining the unit
   * @return number of units within the fragment of the date
   * @throws IllegalArgumentException if the date is <code>null</code> or 
   * fragment is not supported
   * @since 2.4
   */
  private static long getFragment(Date date, int fragment, int unit) {
      if(date == null) {
          throw  new IllegalArgumentException("The date must not be null");
      }
      Calendar calendar = Calendar.getInstance();
      calendar.setTime(date);
      return getFragment(calendar, fragment, unit);
  }

  /**
   * Calendar-version for fragment-calculation in any unit
   * 
   * @param calendar the calendar to work with, not null
   * @param fragment the Calendar field part of calendar to calculate 
   * @param unit Calendar field defining the unit
   * @return number of units within the fragment of the calendar
   * @throws IllegalArgumentException if the date is <code>null</code> or 
   * fragment is not supported
   * @since 2.4
   */
  private static long getFragment(Calendar calendar, int fragment, int unit) {
      if(calendar == null) {
          throw  new IllegalArgumentException("The date must not be null"); 
      }
      long millisPerUnit = getMillisPerUnit(unit);
      long result = 0;
      
      // Fragments bigger than a day require a breakdown to days
      switch (fragment) {
          case Calendar.YEAR:
              result += (calendar.get(Calendar.DAY_OF_YEAR) * MILLIS_PER_DAY) / millisPerUnit;
              break;
          case Calendar.MONTH:
              result += (calendar.get(Calendar.DAY_OF_MONTH) * MILLIS_PER_DAY) / millisPerUnit;
              break;
      }

      switch (fragment) {
          // Number of days already calculated for these cases
          case Calendar.YEAR:
          case Calendar.MONTH:
          
          // The rest of the valid cases
          case Calendar.DAY_OF_YEAR:
          case Calendar.DATE:
              result += (calendar.get(Calendar.HOUR_OF_DAY) * MILLIS_PER_HOUR) / millisPerUnit;
          case Calendar.HOUR_OF_DAY:
              result += (calendar.get(Calendar.MINUTE) * MILLIS_PER_MINUTE) / millisPerUnit;
          case Calendar.MINUTE:
              result += (calendar.get(Calendar.SECOND) * MILLIS_PER_SECOND) / millisPerUnit;
          case Calendar.SECOND:
              result += (calendar.get(Calendar.MILLISECOND) * 1) / millisPerUnit;
              break;
          case Calendar.MILLISECOND: break;//never useful
              default: throw new IllegalArgumentException("The fragment " + fragment + " is not supported");
      }
      return result;
  }

  /**
   * Returns the number of millis of a datefield, if this is a constant value
   * 
   * @param unit A Calendar field which is a valid unit for a fragment
   * @return number of millis
   * @throws IllegalArgumentException if date can't be represented in millisenconds
   * @since 2.4 
   */
  private static long getMillisPerUnit(int unit) {
      long result = Long.MAX_VALUE;
      switch (unit) {
          case Calendar.DAY_OF_YEAR:
          case Calendar.DATE:
              result = MILLIS_PER_DAY;
              break;
          case Calendar.HOUR_OF_DAY:
              result = MILLIS_PER_HOUR;
              break;
          case Calendar.MINUTE:
              result = MILLIS_PER_MINUTE;
              break;
          case Calendar.SECOND:
              result = MILLIS_PER_SECOND;
              break;
          case Calendar.MILLISECOND:
              result = 1;
              break;
          default: throw new IllegalArgumentException("The unit " + unit + " cannot be represented is milleseconds");
      }
      return result;
  }
}

   
    
    
    
    
  








Related examples in the same category

1.Get the days difference
2.Get the days passed from the specified date up to the date provided in the constructor
3.Get the hours difference
4.Get the minutes difference
5.Get the seconds difference
6.Adds a number of days to a date returning a new object.
7.Adds a number of hours to a date returning a new object.
8.Adds a number of milliseconds to a date returning a new object.
9.Adds a number of minutes to a date returning a new object.
10.Adds a number of months to a date returning a new object.
11.Adds a number of seconds to a date returning a new object.
12.Adds a number of weeks to a date returning a new object.
13.Adds a number of years to a date returning a new object.
14.Returns a Date set just to Noon, to the closest possible millisecond of the day.
15.Returns a Date set to the first possible millisecond of the day, just after midnight.
16.Returns a Date set to the first possible millisecond of the month, just after midnight.
17.Returns a Date set to the last possible millisecond of the day, just before midnight.
18.Returns a Date set to the last possible millisecond of the minute.
19.Returns a Date set to the last possible millisecond of the month, just before midnight.
20.Returns a java.sql.Timestamp equal to the current time
21.Returns the number of days within the fragment.
22.Returns the number of hours within the fragment.
23.Returns the number of milliseconds within the fragment.
24.Returns the number of seconds within the fragment.
25.Returns true if endDate is after startDate or if startDate equals endDate.
26.Roll the days forward or backward
27.Roll the java.sql.Date forward or backward
28.Roll the java.util.Date forward or backward
29.Roll the java.util.Time forward or backward
30.Roll the years forward or backward
31.Round this date, leaving the field specified as the most significant field.
32.Checking date as String formatted by a date format
33.Checks if a calendar date is after today and within a number of days in the future
34.Checks if a calendar date is today
35.Checks if a date is after today and within a number of days in the future
36.Checks if the first calendar date is after the second calendar date ignoring time
37.Checks if the first calendar date is before the second calendar date ignoring time
38.Checks if the first date is after the second date ignoring time
39.Checks if the first date is before the second date ignoring time
40.Checks if two calendars represent the same day ignoring time
41.Checks if two dates are on the same day ignoring time
42.Checks the day, month and year are equal
43.Checks the hour, minute and second are equal
44.Make the date go forward of the specified amount of minutes
45.Make the date go back of the specified amount of days
46.Returns the maximum of two dates. A null date is treated as being less than any non-null date
47.Utilities to working with dates java.util.Date
48.Calculate Holidays
49.Compare two dates
50.Convert time in milliseconds into a display string of the form [h]h:mm[am|pm]
51.convert a minute-of-week time to time of day as dd:dd [AM|PM]
52.Convert a minute-of-week time to time of day as dd:dd (24 hour format)
53.Convert passed time into an offset string
54.convert date in milliseconds into the native format of the server - i.e. minute of the week
55.Convert date in milliseconds into minute of the day
56.Convert date in minute of the week format into millisecond format
57.Convert milliseconds into the day of the week string
58.Convert milliseconds into a short day of the week string
59.Convert milliseconds into the month of the year string
60.Convert time to a sliding window format
61.Get age
62.Get Next Monday
63.Get next Sunday
64.Get File system Path From Date
65.Get today's date
66.Get Month, Day of Month, year from a Date
67.A method to get the last day of a month
68.Get Age
69.Get date of yesterday
70.Get date of last week
71.Get date of last month
72.Utility for setting the time on a date.
73.Get last Date of This Month
74.General purpose date utilities.
75.Get Last day from previous Month
76.Get Local Epoch