forked from apache/flink
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[debug] add class back to retrigger CI
- Loading branch information
Showing
1 changed file
with
139 additions
and
0 deletions.
There are no files selected for viewing
139 changes: 139 additions & 0 deletions
139
flink-runtime/src/main/java/org/apache/flink/streaming/api/windowing/time/Time.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,139 @@ | ||
/* | ||
* 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.flink.streaming.api.windowing.time; | ||
|
||
import org.apache.flink.annotation.Public; | ||
|
||
import javax.annotation.Nullable; | ||
|
||
import java.time.Duration; | ||
import java.util.concurrent.TimeUnit; | ||
|
||
import static org.apache.flink.util.Preconditions.checkNotNull; | ||
|
||
/** | ||
* The definition of a time interval for windowing. The time characteristic referred to is the | ||
* default time characteristic set on the execution environment. | ||
* | ||
* @deprecated Use {@link Duration} | ||
*/ | ||
@Deprecated | ||
@Public | ||
public final class Time { | ||
|
||
@Nullable | ||
public static Duration toDuration(@Nullable Time time) { | ||
return time != null ? time.toDuration() : null; | ||
} | ||
|
||
@Nullable | ||
public static Time of(@Nullable Duration duration) { | ||
return duration != null ? Time.milliseconds(duration.toMillis()) : null; | ||
} | ||
|
||
/** The time unit for this policy's time interval. */ | ||
private final TimeUnit unit; | ||
|
||
/** The size of the windows generated by this policy. */ | ||
private final long size; | ||
|
||
/** Instantiation only via factory method. */ | ||
private Time(long size, TimeUnit unit) { | ||
this.unit = checkNotNull(unit, "time unit may not be null"); | ||
this.size = size; | ||
} | ||
|
||
// ------------------------------------------------------------------------ | ||
// Properties | ||
// ------------------------------------------------------------------------ | ||
|
||
/** | ||
* Gets the time unit for this policy's time interval. | ||
* | ||
* @return The time unit for this policy's time interval. | ||
*/ | ||
public TimeUnit getUnit() { | ||
return unit; | ||
} | ||
|
||
/** | ||
* Gets the length of this policy's time interval. | ||
* | ||
* @return The length of this policy's time interval. | ||
*/ | ||
public long getSize() { | ||
return size; | ||
} | ||
|
||
/** | ||
* Converts the time interval to milliseconds. | ||
* | ||
* @return The time interval in milliseconds. | ||
*/ | ||
public long toMilliseconds() { | ||
return unit.toMillis(size); | ||
} | ||
|
||
public Duration toDuration() { | ||
return Duration.ofMillis(this.toMilliseconds()); | ||
} | ||
|
||
// ------------------------------------------------------------------------ | ||
// Factory | ||
// ------------------------------------------------------------------------ | ||
|
||
/** | ||
* Creates a new {@link Time} of the given duration and {@link TimeUnit}. | ||
* | ||
* <p>The {@code Time} refers to the time characteristic that is set on the dataflow via {@link | ||
* org.apache.flink.streaming.api.environment.StreamExecutionEnvironment#setStreamTimeCharacteristic(org.apache.flink.streaming.api.TimeCharacteristic)}. | ||
* | ||
* @param size The duration of time. | ||
* @param unit The unit of time of the duration, for example {@code TimeUnit.SECONDS}. | ||
* @return The time policy. | ||
*/ | ||
public static Time of(long size, TimeUnit unit) { | ||
return new Time(size, unit); | ||
} | ||
|
||
/** Creates a new {@link Time} that represents the given number of milliseconds. */ | ||
public static Time milliseconds(long milliseconds) { | ||
return of(milliseconds, TimeUnit.MILLISECONDS); | ||
} | ||
|
||
/** Creates a new {@link Time} that represents the given number of seconds. */ | ||
public static Time seconds(long seconds) { | ||
return of(seconds, TimeUnit.SECONDS); | ||
} | ||
|
||
/** Creates a new {@link Time} that represents the given number of minutes. */ | ||
public static Time minutes(long minutes) { | ||
return of(minutes, TimeUnit.MINUTES); | ||
} | ||
|
||
/** Creates a new {@link Time} that represents the given number of hours. */ | ||
public static Time hours(long hours) { | ||
return of(hours, TimeUnit.HOURS); | ||
} | ||
|
||
/** Creates a new {@link Time} that represents the given number of days. */ | ||
public static Time days(long days) { | ||
return of(days, TimeUnit.DAYS); | ||
} | ||
} |