All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.kafka.streams.kstream.internals.TimeWindow Maven / Gradle / Ivy

There is a newer version: 3.8.0
Show newest version
/*
 * 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.
 */
package org.apache.kafka.streams.kstream.internals;

import org.apache.kafka.streams.kstream.Window;

/**
 * A {@link TimeWindow} covers a half-open time interval with its start timestamp as an inclusive boundary and its end
 * timestamp as exclusive boundary.
 * It is a fixed size window, i.e., all instances (of a single {@link org.apache.kafka.streams.kstream.TimeWindows
 * window specification}) will have the same size.
 * 

* For time semantics, see {@link org.apache.kafka.streams.processor.TimestampExtractor TimestampExtractor}. * * @see SessionWindow * @see UnlimitedWindow * @see org.apache.kafka.streams.kstream.TimeWindows * @see org.apache.kafka.streams.processor.TimestampExtractor */ public class TimeWindow extends Window { /** * Create a new window for the given start time (inclusive) and end time (exclusive). * * @param startMs the start timestamp of the window (inclusive) * @param endMs the end timestamp of the window (exclusive) * @throws IllegalArgumentException if {@code startMs} is negative or if {@code endMs} is smaller than or equal to * {@code startMs} */ public TimeWindow(final long startMs, final long endMs) throws IllegalArgumentException { super(startMs, endMs); if (startMs == endMs) { throw new IllegalArgumentException("Window endMs must be greater than window startMs."); } } /** * Check if the given window overlaps with this window. * * @param other another window * @return {@code true} if {@code other} overlaps with this window—{@code false} otherwise * @throws IllegalArgumentException if the {@code other} window has a different type than {@code this} window */ @Override public boolean overlap(final Window other) throws IllegalArgumentException { if (getClass() != other.getClass()) { throw new IllegalArgumentException("Cannot compare windows of different type. Other window has type " + other.getClass() + "."); } final TimeWindow otherWindow = (TimeWindow) other; return startMs < otherWindow.endMs && otherWindow.startMs < endMs; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy