This is an automated email from the ASF dual-hosted git repository. fpaul pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/flink.git
commit b6eaefcf1da545b61946a793e34c7cee2c2360f2 Author: Fabian Paul <[email protected]> AuthorDate: Wed May 4 10:50:49 2022 +0200 [FLINK-27486][core] Mark documentation formatting tools as PublicEvolving --- .../archunit-violations/5b9eed8a-5fb6-4373-98ac-3be2a71941b8 | 5 ----- .../org/apache/flink/configuration/description/BlockElement.java | 3 +++ .../java/org/apache/flink/configuration/description/Description.java | 4 ++++ .../apache/flink/configuration/description/DescriptionElement.java | 3 +++ .../java/org/apache/flink/configuration/description/Formatter.java | 3 +++ .../org/apache/flink/configuration/description/InlineElement.java | 3 +++ .../org/apache/flink/configuration/description/LineBreakElement.java | 3 +++ .../java/org/apache/flink/configuration/description/LinkElement.java | 3 +++ .../java/org/apache/flink/configuration/description/ListElement.java | 3 +++ .../java/org/apache/flink/configuration/description/TextElement.java | 4 ++++ 10 files changed, 29 insertions(+), 5 deletions(-) diff --git a/flink-architecture-tests/flink-architecture-tests-production/archunit-violations/5b9eed8a-5fb6-4373-98ac-3be2a71941b8 b/flink-architecture-tests/flink-architecture-tests-production/archunit-violations/5b9eed8a-5fb6-4373-98ac-3be2a71941b8 index 6c1748c842d..8b4e3ad7aaa 100644 --- a/flink-architecture-tests/flink-architecture-tests-production/archunit-violations/5b9eed8a-5fb6-4373-98ac-3be2a71941b8 +++ b/flink-architecture-tests/flink-architecture-tests-production/archunit-violations/5b9eed8a-5fb6-4373-98ac-3be2a71941b8 @@ -1,4 +1,3 @@ -org.apache.flink.api.common.BatchShuffleMode.getDescription(): Returned leaf type org.apache.flink.configuration.description.InlineElement does not satisfy: reside outside of package 'org.apache.flink..' or reside in any package ['..shaded..'] or annotated with @Public or annotated with @PublicEvolving or annotated with @Deprecated org.apache.flink.api.common.ExecutionConfig.getRestartStrategy(): Returned leaf type org.apache.flink.api.common.restartstrategy.RestartStrategies$RestartStrategyConfiguration does not satisfy: reside outside of package 'org.apache.flink..' or reside in any package ['..shaded..'] or annotated with @Public or annotated with @PublicEvolving or annotated with @Deprecated org.apache.flink.api.common.ExecutionConfig.setRestartStrategy(org.apache.flink.api.common.restartstrategy.RestartStrategies$RestartStrategyConfiguration): Argument leaf type org.apache.flink.api.common.restartstrategy.RestartStrategies$RestartStrategyConfiguration does not satisfy: reside outside of package 'org.apache.flink..' or reside in any package ['..shaded..'] or annotated with @Public or annotated with @PublicEvolving or annotated with @Deprecated org.apache.flink.api.common.eventtime.TimestampAssignerSupplier.createTimestampAssigner(org.apache.flink.api.common.eventtime.TimestampAssignerSupplier$Context): Argument leaf type org.apache.flink.api.common.eventtime.TimestampAssignerSupplier$Context does not satisfy: reside outside of package 'org.apache.flink..' or reside in any package ['..shaded..'] or annotated with @Public or annotated with @PublicEvolving or annotated with @Deprecated @@ -49,13 +48,9 @@ org.apache.flink.client.program.StreamContextEnvironment.setAsContext(org.apache org.apache.flink.client.program.StreamPlanEnvironment.executeAsync(org.apache.flink.streaming.api.graph.StreamGraph): Argument leaf type org.apache.flink.streaming.api.graph.StreamGraph does not satisfy: reside outside of package 'org.apache.flink..' or reside in any package ['..shaded..'] or annotated with @Public or annotated with @PublicEvolving or annotated with @Deprecated org.apache.flink.client.program.StreamPlanEnvironment.getPipeline(): Returned leaf type org.apache.flink.api.dag.Pipeline does not satisfy: reside outside of package 'org.apache.flink..' or reside in any package ['..shaded..'] or annotated with @Public or annotated with @PublicEvolving or annotated with @Deprecated org.apache.flink.configuration.ClusterOptions.getSchedulerType(org.apache.flink.configuration.Configuration): Returned leaf type org.apache.flink.configuration.JobManagerOptions$SchedulerType does not satisfy: reside outside of package 'org.apache.flink..' or reside in any package ['..shaded..'] or annotated with @Public or annotated with @PublicEvolving or annotated with @Deprecated -org.apache.flink.configuration.ConfigOption.description(): Returned leaf type org.apache.flink.configuration.description.Description does not satisfy: reside outside of package 'org.apache.flink..' or reside in any package ['..shaded..'] or annotated with @Public or annotated with @PublicEvolving or annotated with @Deprecated org.apache.flink.configuration.ConfigOption.fallbackKeys(): Returned leaf type org.apache.flink.configuration.FallbackKey does not satisfy: reside outside of package 'org.apache.flink..' or reside in any package ['..shaded..'] or annotated with @Public or annotated with @PublicEvolving or annotated with @Deprecated -org.apache.flink.configuration.ConfigOption.withDescription(org.apache.flink.configuration.description.Description): Argument leaf type org.apache.flink.configuration.description.Description does not satisfy: reside outside of package 'org.apache.flink..' or reside in any package ['..shaded..'] or annotated with @Public or annotated with @PublicEvolving or annotated with @Deprecated org.apache.flink.configuration.ConfigOptions.key(java.lang.String): Returned leaf type org.apache.flink.configuration.ConfigOptions$OptionBuilder does not satisfy: reside outside of package 'org.apache.flink..' or reside in any package ['..shaded..'] or annotated with @Public or annotated with @PublicEvolving or annotated with @Deprecated -org.apache.flink.configuration.DescribedEnum.getDescription(): Returned leaf type org.apache.flink.configuration.description.InlineElement does not satisfy: reside outside of package 'org.apache.flink..' or reside in any package ['..shaded..'] or annotated with @Public or annotated with @PublicEvolving or annotated with @Deprecated org.apache.flink.configuration.MemorySize.parse(java.lang.String, org.apache.flink.configuration.MemorySize$MemoryUnit): Argument leaf type org.apache.flink.configuration.MemorySize$MemoryUnit does not satisfy: reside outside of package 'org.apache.flink..' or reside in any package ['..shaded..'] or annotated with @Public or annotated with @PublicEvolving or annotated with @Deprecated -org.apache.flink.connector.base.DeliveryGuarantee.getDescription(): Returned leaf type org.apache.flink.configuration.description.InlineElement does not satisfy: reside outside of package 'org.apache.flink..' or reside in any package ['..shaded..'] or annotated with @Public or annotated with @PublicEvolving or annotated with @Deprecated org.apache.flink.connector.base.source.hybrid.HybridSource.builder(org.apache.flink.api.connector.source.Source): Returned leaf type org.apache.flink.connector.base.source.hybrid.HybridSource$HybridSourceBuilder does not satisfy: reside outside of package 'org.apache.flink..' or reside in any package ['..shaded..'] or annotated with @Public or annotated with @PublicEvolving or annotated with @Deprecated org.apache.flink.connector.base.source.hybrid.HybridSource.createEnumerator(org.apache.flink.api.connector.source.SplitEnumeratorContext): Argument leaf type org.apache.flink.connector.base.source.hybrid.HybridSourceSplit does not satisfy: reside outside of package 'org.apache.flink..' or reside in any package ['..shaded..'] or annotated with @Public or annotated with @PublicEvolving or annotated with @Deprecated org.apache.flink.connector.base.source.hybrid.HybridSource.createEnumerator(org.apache.flink.api.connector.source.SplitEnumeratorContext): Returned leaf type org.apache.flink.connector.base.source.hybrid.HybridSourceEnumeratorState does not satisfy: reside outside of package 'org.apache.flink..' or reside in any package ['..shaded..'] or annotated with @Public or annotated with @PublicEvolving or annotated with @Deprecated diff --git a/flink-core/src/main/java/org/apache/flink/configuration/description/BlockElement.java b/flink-core/src/main/java/org/apache/flink/configuration/description/BlockElement.java index 89aba81609f..48dfba492ba 100644 --- a/flink-core/src/main/java/org/apache/flink/configuration/description/BlockElement.java +++ b/flink-core/src/main/java/org/apache/flink/configuration/description/BlockElement.java @@ -18,5 +18,8 @@ package org.apache.flink.configuration.description; +import org.apache.flink.annotation.PublicEvolving; + /** Part of description that represents a block e.g. some text, linebreak or a list. */ +@PublicEvolving public interface BlockElement extends DescriptionElement {} diff --git a/flink-core/src/main/java/org/apache/flink/configuration/description/Description.java b/flink-core/src/main/java/org/apache/flink/configuration/description/Description.java index 0f9d3e28a55..9e92bfca57b 100644 --- a/flink-core/src/main/java/org/apache/flink/configuration/description/Description.java +++ b/flink-core/src/main/java/org/apache/flink/configuration/description/Description.java @@ -18,6 +18,8 @@ package org.apache.flink.configuration.description; +import org.apache.flink.annotation.PublicEvolving; + import java.util.ArrayList; import java.util.List; @@ -25,6 +27,7 @@ import java.util.List; * Description for {@link org.apache.flink.configuration.ConfigOption}. Allows providing multiple * rich formats. */ +@PublicEvolving public class Description { private final List<BlockElement> blocks; @@ -50,6 +53,7 @@ public class Description { * .build(); * }</pre> */ + @PublicEvolving public static class DescriptionBuilder { private final List<BlockElement> blocks = new ArrayList<>(); diff --git a/flink-core/src/main/java/org/apache/flink/configuration/description/DescriptionElement.java b/flink-core/src/main/java/org/apache/flink/configuration/description/DescriptionElement.java index 9a8f8a18b51..56b64c4a458 100644 --- a/flink-core/src/main/java/org/apache/flink/configuration/description/DescriptionElement.java +++ b/flink-core/src/main/java/org/apache/flink/configuration/description/DescriptionElement.java @@ -18,7 +18,10 @@ package org.apache.flink.configuration.description; +import org.apache.flink.annotation.PublicEvolving; + /** Part of a {@link Description} that can be converted into String representation. */ +@PublicEvolving interface DescriptionElement { /** * Transforms itself into String representation using given format. diff --git a/flink-core/src/main/java/org/apache/flink/configuration/description/Formatter.java b/flink-core/src/main/java/org/apache/flink/configuration/description/Formatter.java index 0198ae94020..3dcd89f8883 100644 --- a/flink-core/src/main/java/org/apache/flink/configuration/description/Formatter.java +++ b/flink-core/src/main/java/org/apache/flink/configuration/description/Formatter.java @@ -18,12 +18,15 @@ package org.apache.flink.configuration.description; +import org.apache.flink.annotation.PublicEvolving; + import java.util.EnumSet; /** * Allows providing multiple formatters for the description. E.g. Html formatter, Markdown formatter * etc. */ +@PublicEvolving public abstract class Formatter { private final StringBuilder state = new StringBuilder(); diff --git a/flink-core/src/main/java/org/apache/flink/configuration/description/InlineElement.java b/flink-core/src/main/java/org/apache/flink/configuration/description/InlineElement.java index d67412bdfac..c1d3892fb90 100644 --- a/flink-core/src/main/java/org/apache/flink/configuration/description/InlineElement.java +++ b/flink-core/src/main/java/org/apache/flink/configuration/description/InlineElement.java @@ -18,5 +18,8 @@ package org.apache.flink.configuration.description; +import org.apache.flink.annotation.PublicEvolving; + /** Part of description that represents an element inside a block e.g. a link. */ +@PublicEvolving public interface InlineElement extends DescriptionElement {} diff --git a/flink-core/src/main/java/org/apache/flink/configuration/description/LineBreakElement.java b/flink-core/src/main/java/org/apache/flink/configuration/description/LineBreakElement.java index e7aa7eed4cb..625e1a498ab 100644 --- a/flink-core/src/main/java/org/apache/flink/configuration/description/LineBreakElement.java +++ b/flink-core/src/main/java/org/apache/flink/configuration/description/LineBreakElement.java @@ -18,7 +18,10 @@ package org.apache.flink.configuration.description; +import org.apache.flink.annotation.PublicEvolving; + /** Represents a line break in the {@link Description}. */ +@PublicEvolving public class LineBreakElement implements InlineElement, BlockElement { /** Creates a line break in the description. */ diff --git a/flink-core/src/main/java/org/apache/flink/configuration/description/LinkElement.java b/flink-core/src/main/java/org/apache/flink/configuration/description/LinkElement.java index f60c64ae46a..b55b9056f47 100644 --- a/flink-core/src/main/java/org/apache/flink/configuration/description/LinkElement.java +++ b/flink-core/src/main/java/org/apache/flink/configuration/description/LinkElement.java @@ -18,7 +18,10 @@ package org.apache.flink.configuration.description; +import org.apache.flink.annotation.PublicEvolving; + /** Element that represents a link in the {@link Description}. */ +@PublicEvolving public class LinkElement implements InlineElement { private final String link; private final String text; diff --git a/flink-core/src/main/java/org/apache/flink/configuration/description/ListElement.java b/flink-core/src/main/java/org/apache/flink/configuration/description/ListElement.java index d25c4657831..f592673045a 100644 --- a/flink-core/src/main/java/org/apache/flink/configuration/description/ListElement.java +++ b/flink-core/src/main/java/org/apache/flink/configuration/description/ListElement.java @@ -18,10 +18,13 @@ package org.apache.flink.configuration.description; +import org.apache.flink.annotation.PublicEvolving; + import java.util.Arrays; import java.util.List; /** Represents a list in the {@link Description}. */ +@PublicEvolving public class ListElement implements BlockElement { private final List<InlineElement> entries; diff --git a/flink-core/src/main/java/org/apache/flink/configuration/description/TextElement.java b/flink-core/src/main/java/org/apache/flink/configuration/description/TextElement.java index 348b174160e..0e0ec7e4e70 100644 --- a/flink-core/src/main/java/org/apache/flink/configuration/description/TextElement.java +++ b/flink-core/src/main/java/org/apache/flink/configuration/description/TextElement.java @@ -18,6 +18,8 @@ package org.apache.flink.configuration.description; +import org.apache.flink.annotation.PublicEvolving; + import org.apache.flink.shaded.guava30.com.google.common.base.Strings; import java.util.Arrays; @@ -26,6 +28,7 @@ import java.util.EnumSet; import java.util.List; /** Represents a text block in the {@link Description}. */ +@PublicEvolving public class TextElement implements BlockElement, InlineElement { private final String format; private final List<InlineElement> elements; @@ -95,6 +98,7 @@ public class TextElement implements BlockElement, InlineElement { } /** Styles that can be applied to {@link TextElement} e.g. code, bold etc. */ + @PublicEvolving public enum TextStyle { CODE }
