Package org.apache.kafka.streams.kstream.internals

Class TimeWindow

java.lang.Object

org.apache.kafka.streams.kstream.Window

org.apache.kafka.streams.kstream.internals.TimeWindow

public class TimeWindow
extends Window

A 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 window specification) will have the same size.

For time semantics, see TimestampExtractor.

See Also:

SessionWindow, UnlimitedWindow, TimeWindows, TimestampExtractor

Field Summary

Fields inherited from class org.apache.kafka.streams.kstream.Window

endMs, startMs

Constructor Summary

Constructors

Constructor	Description
TimeWindow(long startMs, long endMs)	Create a new window for the given start time (inclusive) and end time (exclusive).

Method Summary

Modifier and Type	Method	Description
boolean	overlap(Window other)	Check if the given window overlaps with this window.

Methods inherited from class org.apache.kafka.streams.kstream.Window

end, endTime, equals, hashCode, start, startTime, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeWindow

public TimeWindow(long startMs,
                  long endMs)
           throws IllegalArgumentException

Create a new window for the given start time (inclusive) and end time (exclusive).

Parameters:

startMs - the start timestamp of the window (inclusive)

endMs - the end timestamp of the window (exclusive)

Throws:

IllegalArgumentException - if startMs is negative or if endMs is smaller than or equal to startMs

Method Detail

overlap

public boolean overlap(Window other)
                throws IllegalArgumentException

Check if the given window overlaps with this window.

Specified by:

overlap in class Window

Parameters:

other - another window

Returns:

true if other overlaps with this window—false otherwise

Throws:

IllegalArgumentException - if the other window has a different type than this window