org.dmfs.rfc5545.recur.UntilLimiter Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2013 Marten Gajda 
 *
 * 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 org.dmfs.rfc5545.recur;

import org.dmfs.rfc5545.DateTime;
import org.dmfs.rfc5545.Instance;

import java.util.TimeZone;


/**
 * A {@link Limiter} that filters all instances after a certain date (the one specified in the UNTIL part).
 *
 * @author Marten Gajda
 */
final class UntilLimiter extends Limiter
{
    /**
     * The latest allowed instance start date.
     */
    private final long mUntil;


    /**
     * Create a new limiter for the UNTIL part.
     *
     * @param rule
     *     The {@link RecurrenceRule} to filter.
     * @param previous
     *     The previous filter instance.
     */
    public UntilLimiter(RecurrenceRule rule, RuleIterator previous, TimeZone startTimezone)
    {
        super(previous);
        DateTime until = rule.getUntil();
        if (!until.isFloating())
        {
            until = until.shiftTimeZone(startTimezone);
        }
        mUntil = until.getInstance();
    }


    @Override
    boolean stop(long instance)
    {
        return mUntil < Instance.maskWeekday(instance);
    }
}