org.springmodules.validation.util.condition.date.jodatime.IsBeforeInstantCondition.java Source code

Introduction

Here is the source code for org.springmodules.validation.util.condition.date.jodatime.IsBeforeInstantCondition.java

Source

/*
 * Copyright 2004-2009 the original author or authors.
 *
 * 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.springmodules.validation.util.condition.date.jodatime;

import java.util.Calendar;
import java.util.Date;

import org.joda.time.DateTime;
import org.joda.time.DateTimeZone;
import org.joda.time.ReadableInstant;

/**
 * An {@link AbstractInstantCondition} implementation that checks whether the checked instant comes chronologically
 * before another instant.
 *
 * @author Uri Boness
 */
public class IsBeforeInstantCondition extends AbstractInstantCondition {

    private ReadableInstant later;

    /**
     * Constructs a new IsBeforeDateCondition with a given instant to be checked against.
     *
     * @param later The instant that this instantCondition will checkCalendar against.
     */
    public IsBeforeInstantCondition(ReadableInstant later) {
        this.later = later;
    }

    /**
     * Constructs a new IsBeforeDateCondition with a given date to be checked against.
     *
     * @param later The date that this instantCondition will checkCalendar against.
     */
    public IsBeforeInstantCondition(Date later) {
        this.later = new DateTime(later.getTime());
    }

    /**
     * Constructs a new IsBeforeDateCondition with a given calendar to be checked against.
     *
     * @param later The calendar that this instantCondition will checkCalendar against.
     */
    public IsBeforeInstantCondition(Calendar later) {
        this.later = new DateTime(later.getTimeInMillis(), DateTimeZone.forTimeZone(later.getTimeZone()));
    }

    /**
     * Checks whether the given instant comes chronologically before the instant associated with this instantCondition.
     *
     * @param instant The instance to be checked.
     * @return <code>true</code> if the given instant comes before the instant associated with this instantCondition,
     *         <code>false</code> otherwise.
     */
    protected boolean checkInstant(ReadableInstant instant) {
        return later.isAfter(instant);
    }

    //=============================================== Setter/Getter ====================================================

    /**
     * Returns the instant associated with this condition.
     *
     * @return The instant associated with this condition.
     */
    public ReadableInstant getLater() {
        return later;
    }

}