Java Date Add add(Date date, int calendarField, int amount)

Description

Adds to a date returning a new object.

License

Apache License

Parameter

Parameter	Description
date	the date, not null
calendarField	the calendar field to add to
amount	the amount to add, may be negative

Exception

Parameter	Description
IllegalArgumentException	if the date is null

Return

the new date object with the amount added

Declaration

public static Date add(Date date, int calendarField, int amount) 

Method Source Code

//package com.java2s;
/*/*from w w  w  .  j a va  2 s . c  o  m*/
 * 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.
 */

import java.util.*;

public class Main {
    /**
     * Adds to a date returning a new object.
     * The original date object is unchanged.
     *
     * @param date          the date, not null
     * @param calendarField the calendar field to add to
     * @param amount        the amount to add, may be negative
     * @return the new date object with the amount added
     * @throws IllegalArgumentException if the date is null
     */
    public static Date add(Date date, int calendarField, int amount) {
        if (date == null) {
            throw new IllegalArgumentException("The date must not be null");
        }
        Calendar c = Calendar.getInstance();
        c.setTime(date);
        c.add(calendarField, amount);
        return c.getTime();
    }
}

Related

1. add(Date actual, Integer type, Integer count)
2. add(Date date, int calendarField, int amount)
3. add(Date date, int calendarField, int amount)
4. add(Date date, int field, int amount)
5. add(Date date, int field, int amount)