Java.util.GregorianCalendar.getLeast Maximum() Method

Description

The java.util.GregorianCalendar.getLeastMaximum(int field) method returns the lowest maximum value for the given calendar field of this GregorianCalendar instance. The lowest maximum value is defined as the smallest value returned by getActualMaximum(int) for any possible time value, taking into consideration the current values of the getFirstDayOfWeek, getMinimalDaysInFirstWeek, getGregorianChange and getTimeZone methods.

Declaration

Following is the declaration for java.util.GregorianCalendar.getLeastMaximum() method

public int getLeastMaximum(int field)

Parameters

field − the calendar field

Return Value

This method returns the lowest maximum value for the given calendar field.

Exception

NA

Example

The following example shows the usage of java.util.GregorianCalendar.getLeastMaximum() method.

package com.tutorialspoint;

import java.util.*;

public class GregorianCalendarDemo {
   public static void main(String[] args) {

      // create a new calendar
      GregorianCalendar cal = (GregorianCalendar) GregorianCalendar.getInstance();

      // print the current date and time
      System.out.println("" + cal.getTime());

      // get least maximum for day_of_month
      int min = cal.getLeastMaximum(GregorianCalendar.DAY_OF_MONTH);
      System.out.println("Least Maximum:" + min);

      // get least maximum for YEAR
      min = cal.getLeastMaximum(GregorianCalendar.YEAR);
      System.out.println("Least Maximum:" + min);
   }
}

Let us compile and run the above program, this will produce the following result −

Fri May 18 03:08:38 EEST 2012
Least Maximum:28
Least Maximum:292269054