forked from apache/flink
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FLINK-9792] Added custom Description class for ConfigOptions to enab…
…le rich formatting. This closes apache#6312
- Loading branch information
Showing
19 changed files
with
774 additions
and
28 deletions.
There are no files selected for viewing
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
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
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
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
26 changes: 26 additions & 0 deletions
26
flink-core/src/main/java/org/apache/flink/configuration/description/BlockElement.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,26 @@ | ||
| /* | ||
| * 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 | ||
| * | ||
| * https://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.configuration.description; | ||
|
|
||
| /** | ||
| * Part of description that represents a block e.g. some text, linebreak or a list. | ||
| */ | ||
| public interface BlockElement extends DescriptionElement { | ||
|
|
||
| } |
109 changes: 109 additions & 0 deletions
109
flink-core/src/main/java/org/apache/flink/configuration/description/Description.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,109 @@ | ||
| /* | ||
| * 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 | ||
| * | ||
| * https://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.configuration.description; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| /** | ||
| * Description for {@link org.apache.flink.configuration.ConfigOption}. Allows providing multiple rich formats. | ||
| */ | ||
| public class Description { | ||
|
|
||
| private final List<BlockElement> blocks; | ||
|
|
||
| public static DescriptionBuilder builder() { | ||
| return new DescriptionBuilder(); | ||
| } | ||
|
|
||
| public List<BlockElement> getBlocks() { | ||
| return blocks; | ||
| } | ||
|
|
||
| /** | ||
| * Builder for {@link Description}. Allows adding a rich formatting like lists, links, linebreaks etc. | ||
| * For example: | ||
| * <pre>{@code | ||
| * Description description = Description.builder() | ||
| * .text("This is some list: ") | ||
| * .list( | ||
| * text("this is first element of list"), | ||
| * text("this is second element of list with a %s", link("https://link"))) | ||
| * .build(); | ||
| * }</pre> | ||
| */ | ||
| public static class DescriptionBuilder { | ||
|
|
||
| private final List<BlockElement> blocks = new ArrayList<>(); | ||
|
|
||
| /** | ||
| * Adds a block of text with placeholders ("%s") that will be replaced with proper string representation of | ||
| * given {@link InlineElement}. For example: | ||
| * | ||
| * <p>{@code text("This is a text with a link %s", link("https://somepage", "to here"))} | ||
| * | ||
| * @param format text with placeholders for elements | ||
| * @param elements elements to be put in the text | ||
| * @return description with added block of text | ||
| */ | ||
| public DescriptionBuilder text(String format, InlineElement... elements) { | ||
| blocks.add(TextElement.text(format, elements)); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Creates a simple block of text. | ||
| * | ||
| * @param text a simple block of text | ||
| * @return block of text | ||
| */ | ||
| public DescriptionBuilder text(String text) { | ||
| blocks.add(TextElement.text(text)); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Creates a line break in the description. | ||
| */ | ||
| public DescriptionBuilder linebreak() { | ||
| blocks.add(LineBreakElement.linebreak()); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Adds a bulleted list to the description. | ||
| */ | ||
| public DescriptionBuilder list(InlineElement... elements) { | ||
| blocks.add(ListElement.list(elements)); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Creates description representation. | ||
| */ | ||
| public Description build() { | ||
| return new Description(blocks); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| private Description(List<BlockElement> blocks) { | ||
| this.blocks = blocks; | ||
| } | ||
| } |
31 changes: 31 additions & 0 deletions
31
flink-core/src/main/java/org/apache/flink/configuration/description/DescriptionElement.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,31 @@ | ||
| /* | ||
| * 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 | ||
| * | ||
| * https://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.configuration.description; | ||
|
|
||
| /** | ||
| * Part of a {@link Description} that can be converted into String representation. | ||
| */ | ||
| interface DescriptionElement { | ||
| /** | ||
| * Transforms itself into String representation using given format. | ||
| * | ||
| * @param formatter formatter to use. | ||
| */ | ||
| void format(Formatter formatter); | ||
| } |
Oops, something went wrong.