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

Class SessionWindow

java.lang.Object

org.apache.kafka.streams.kstream.Window

org.apache.kafka.streams.kstream.internals.SessionWindow

public final class SessionWindow
extends Window

A session window covers a closed time interval with its start and end timestamp both being an inclusive boundary.

For time semantics, see TimestampExtractor.

See Also:

TimeWindow, UnlimitedWindow, SessionWindows, TimestampExtractor

Field Summary

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

endMs, startMs

Constructor Summary

Constructors

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

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

SessionWindow

public SessionWindow(long startMs,
                     long endMs)
              throws IllegalArgumentException

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

Parameters:

startMs - the start timestamp of the window

endMs - the end timestamp of the window

Throws:

IllegalArgumentException - if startMs is negative or if endMs is smaller than 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