net.sf.eBusx.time.package-info Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of extensions Show documentation
The newest version!
//
// Copyright 2021 Charles W. Rapp
//
// 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.
//

/**
 * This package provides single Java class:
 * {@link net.sf.eBusx.time.EInterval}. An {@code EInterval}
 * defines two instances: a begin time and an end time where
 * begin time is ≤ to the end time. These time may be
 * separately marked as inclusive or exclusive. If begin time and
 * end time are equal then both times must be marked as
 * inclusive.
 * 
 * While {@code EInterval} overrides {@code equals(Object)} it
 * does not implement the {@link java.lang.Comparable} interface.
 * Instead {@code EInterval} implements Allen's Interval Algebra
 * via the following methods:
 * 
 * 
 *   
 *     {@link net.sf.eBusx.time.EInterval#precedes(net.sf.eBusx.time.EInterval) precedes},
 *   
 *   
 *     {@link net.sf.eBusx.time.EInterval#meets(net.sf.eBusx.time.EInterval) meets},
 *   
 *   
 *     {@link net.sf.eBusx.time.EInterval#overlaps(net.sf.eBusx.time.EInterval) overlaps},
 *   
 *   
 *     {@link net.sf.eBusx.time.EInterval#contains(net.sf.eBusx.time.EInterval) contains},
 *   
 *   
 *     {@link net.sf.eBusx.time.EInterval#starts(net.sf.eBusx.time.EInterval) starts}, and
 *   
 *   
 *     {@link net.sf.eBusx.time.EInterval#finishes(net.sf.eBusx.time.EInterval) finishes}.
 *   
 * 
 */

package net.sf.eBusx.time;