Index (polaris-config-docs-generator 1.7.0.0-dep-1020 API)

A B C D E F G H I M N O P R S T U V W
All Classes and Interfaces|All Packages

A

addProperty(String, SmallRyeConfigPropertyInfo, MarkdownPropertyFormatter) - Method in class org.apache.polaris.docs.generator.SmallRyeConfigSectionPage
addProperty(PolarisConfigurationInfo) - Method in class org.apache.polaris.docs.generator.PolarisConfigurationSectionPage

B

behaviorChangeConfigs() - Method in class org.apache.polaris.docs.generator.PolarisConfigurationConfigs
byStorageType() - Method in class org.apache.polaris.docs.generator.StorageAccessPropertyConfigs: Returns properties grouped by storage type, in declaration order per group.

C

call() - Method in class org.apache.polaris.docs.generator.ReferenceConfigDocsGenerator
catalogConfig() - Method in record class org.apache.polaris.docs.generator.PolarisConfigurationInfo: Returns the value of the catalogConfig record component.

D

defaultValue() - Method in record class org.apache.polaris.docs.generator.PolarisConfigurationInfo: Returns the value of the defaultValue record component.
defaultValue() - Method in class org.apache.polaris.docs.generator.PropertiesConfigItem
defaultValue() - Method in interface org.apache.polaris.docs.generator.PropertyInfo
defaultValue() - Method in class org.apache.polaris.docs.generator.SmallRyeConfigPropertyInfo
defaultValue(ConfigMappingInterface.Property) - Static method in class org.apache.polaris.docs.generator.SmallRyeConfigPropertyInfo
description() - Method in class org.apache.polaris.docs.generator.MarkdownFormatter
description() - Method in record class org.apache.polaris.docs.generator.PolarisConfigurationInfo: Returns the value of the description record component.
description() - Method in record class org.apache.polaris.docs.generator.StorageAccessPropertyInfo: Returns the value of the description record component.
doc() - Method in class org.apache.polaris.docs.generator.PropertiesConfigItem
doc() - Method in interface org.apache.polaris.docs.generator.PropertyInfo
doc() - Method in class org.apache.polaris.docs.generator.SmallRyeConfigPropertyInfo
DocGenDoclet - Class in org.apache.polaris.docs.generator
DocGenDoclet() - Constructor for class org.apache.polaris.docs.generator.DocGenDoclet

E

enumTooltipText() - Method in interface org.apache.polaris.docs.generator.PropertyInfo
enumTooltipText() - Method in class org.apache.polaris.docs.generator.SmallRyeConfigPropertyInfo
enumTooltipText(ConfigMappingInterface.Property) - Static method in class org.apache.polaris.docs.generator.SmallRyeConfigPropertyInfo
equals(Object) - Method in record class org.apache.polaris.docs.generator.PolarisConfigurationInfo: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.apache.polaris.docs.generator.StorageAccessPropertyInfo: Indicates whether some other object is "equal to" this one.
EXPECTED_FIELD_MODIFIERS - Static variable in class org.apache.polaris.docs.generator.PropertiesConfigPageGroup

F

featureConfigs() - Method in class org.apache.polaris.docs.generator.PolarisConfigurationConfigs
forEachSection(BiConsumer<String, Iterable<PropertiesConfigItem>>) - Method in class org.apache.polaris.docs.generator.PropertiesConfigPageGroup

G

getConfigMappingInfo(Class<?>) - Method in class org.apache.polaris.docs.generator.SmallRyeConfigs
getName() - Method in class org.apache.polaris.docs.generator.DocGenDoclet
getSupportedOptions() - Method in class org.apache.polaris.docs.generator.DocGenDoclet
getSupportedSourceVersion() - Method in class org.apache.polaris.docs.generator.DocGenDoclet
groupType() - Method in class org.apache.polaris.docs.generator.PropertiesConfigItem
groupType() - Method in interface org.apache.polaris.docs.generator.PropertyInfo
groupType() - Method in class org.apache.polaris.docs.generator.SmallRyeConfigPropertyInfo

H

hashCode() - Method in record class org.apache.polaris.docs.generator.PolarisConfigurationInfo: Returns a hash code value for this object.
hashCode() - Method in record class org.apache.polaris.docs.generator.StorageAccessPropertyInfo: Returns a hash code value for this object.

I

incrementSectionRef() - Method in class org.apache.polaris.docs.generator.SmallRyeConfigSectionPage
init(Locale, Reporter) - Method in class org.apache.polaris.docs.generator.DocGenDoclet
isCredential() - Method in record class org.apache.polaris.docs.generator.StorageAccessPropertyInfo: Returns the value of the isCredential record component.
isEmpty() - Method in class org.apache.polaris.docs.generator.PolarisConfigurationSectionPage
isEmpty() - Method in class org.apache.polaris.docs.generator.SmallRyeConfigSectionPage
isHidden() - Method in class org.apache.polaris.docs.generator.MarkdownFormatter
isPrefixProperty() - Method in record class org.apache.polaris.docs.generator.StorageAccessPropertyInfo
isSettableType() - Method in class org.apache.polaris.docs.generator.SmallRyeConfigPropertyInfo
isSettableType(ConfigMappingInterface.Property) - Static method in class org.apache.polaris.docs.generator.SmallRyeConfigPropertyInfo

M

main(String[]) - Static method in class org.apache.polaris.docs.generator.ReferenceConfigDocsGenerator
MarkdownFormatter - Class in org.apache.polaris.docs.generator
MarkdownFormatter(Element, DocCommentTree) - Constructor for class org.apache.polaris.docs.generator.MarkdownFormatter
MarkdownPropertyFormatter - Class in org.apache.polaris.docs.generator
MarkdownPropertyFormatter(PropertyInfo) - Constructor for class org.apache.polaris.docs.generator.MarkdownPropertyFormatter
MarkdownTypeFormatter - Class in org.apache.polaris.docs.generator
MarkdownTypeFormatter(Element, DocCommentTree) - Constructor for class org.apache.polaris.docs.generator.MarkdownTypeFormatter

N

name() - Method in class org.apache.polaris.docs.generator.PropertiesConfigPageGroup

O

org.apache.polaris.docs.generator - package org.apache.polaris.docs.generator

P

page(String) - Method in class org.apache.polaris.docs.generator.PropertiesConfigs
pages() - Method in class org.apache.polaris.docs.generator.PropertiesConfigs
PolarisConfigurationConfigs - Class in org.apache.polaris.docs.generator: Processes FeatureConfiguration and BehaviorChangeConfiguration static fields to extract configuration documentation.
PolarisConfigurationConfigs(DocletEnvironment) - Constructor for class org.apache.polaris.docs.generator.PolarisConfigurationConfigs
PolarisConfigurationInfo - Record Class in org.apache.polaris.docs.generator: Holds information about a PolarisConfiguration (FeatureConfiguration or BehaviorChangeConfiguration) extracted from static fields.
PolarisConfigurationInfo(String, String, String, String, String) - Constructor for record class org.apache.polaris.docs.generator.PolarisConfigurationInfo: Creates an instance of a PolarisConfigurationInfo record class.
PolarisConfigurationSectionPage - Class in org.apache.polaris.docs.generator: Generates a markdown page section for PolarisConfiguration (FeatureConfiguration or BehaviorChangeConfiguration).
PolarisConfigurationSectionPage(String) - Constructor for class org.apache.polaris.docs.generator.PolarisConfigurationSectionPage
prefixOverride() - Method in class org.apache.polaris.docs.generator.SmallRyeConfigPropertyInfo
properties(DocletEnvironment) - Method in class org.apache.polaris.docs.generator.SmallRyeConfigMappingInfo
PropertiesConfigItem - Class in org.apache.polaris.docs.generator
PropertiesConfigItem(VariableElement, DocCommentTree) - Constructor for class org.apache.polaris.docs.generator.PropertiesConfigItem
PropertiesConfigPageGroup - Class in org.apache.polaris.docs.generator
PropertiesConfigPageGroup(String) - Constructor for class org.apache.polaris.docs.generator.PropertiesConfigPageGroup
PropertiesConfigs - Class in org.apache.polaris.docs.generator
PropertiesConfigs(DocletEnvironment) - Constructor for class org.apache.polaris.docs.generator.PropertiesConfigs
propertyElement() - Method in class org.apache.polaris.docs.generator.PropertiesConfigItem
propertyElement() - Method in interface org.apache.polaris.docs.generator.PropertyInfo
propertyElement() - Method in class org.apache.polaris.docs.generator.SmallRyeConfigPropertyInfo
PropertyInfo - Interface in org.apache.polaris.docs.generator
propertyName() - Method in class org.apache.polaris.docs.generator.MarkdownPropertyFormatter
propertyName() - Method in record class org.apache.polaris.docs.generator.PolarisConfigurationInfo: Returns the value of the propertyName record component.
propertyName() - Method in class org.apache.polaris.docs.generator.PropertiesConfigItem
propertyName() - Method in interface org.apache.polaris.docs.generator.PropertyInfo
propertyName() - Method in class org.apache.polaris.docs.generator.SmallRyeConfigPropertyInfo
propertyName() - Method in record class org.apache.polaris.docs.generator.StorageAccessPropertyInfo: Returns the value of the propertyName record component.
propertySuffix() - Method in class org.apache.polaris.docs.generator.MarkdownPropertyFormatter
propertySuffix() - Method in class org.apache.polaris.docs.generator.PropertiesConfigItem
propertySuffix() - Method in interface org.apache.polaris.docs.generator.PropertyInfo
propertySuffix() - Method in class org.apache.polaris.docs.generator.SmallRyeConfigPropertyInfo
propertyType() - Method in class org.apache.polaris.docs.generator.MarkdownPropertyFormatter

R

ReferenceConfigDocsGenerator - Class in org.apache.polaris.docs.generator: Tool to run DocGenDoclet, the markdown docs generation.
ReferenceConfigDocsGenerator() - Constructor for class org.apache.polaris.docs.generator.ReferenceConfigDocsGenerator
ReferenceConfigDocsGenerator(List<Path>, List<Path>, Path, boolean) - Constructor for class org.apache.polaris.docs.generator.ReferenceConfigDocsGenerator
run(DocletEnvironment) - Method in class org.apache.polaris.docs.generator.DocGenDoclet

S

sectionDocFromType() - Method in class org.apache.polaris.docs.generator.SmallRyeConfigPropertyInfo
sectionItems() - Method in class org.apache.polaris.docs.generator.PropertiesConfigPageGroup
simplifiedTypeName() - Method in class org.apache.polaris.docs.generator.PropertiesConfigItem
simplifiedTypeName() - Method in interface org.apache.polaris.docs.generator.PropertyInfo
simplifiedTypeName() - Method in class org.apache.polaris.docs.generator.SmallRyeConfigPropertyInfo
simplifiedTypeName(ConfigMappingInterface.Property) - Static method in class org.apache.polaris.docs.generator.SmallRyeConfigPropertyInfo
SmallRyeConfigMappingInfo - Class in org.apache.polaris.docs.generator
SmallRyeConfigPropertyInfo - Class in org.apache.polaris.docs.generator
SmallRyeConfigs - Class in org.apache.polaris.docs.generator
SmallRyeConfigs(DocletEnvironment) - Constructor for class org.apache.polaris.docs.generator.SmallRyeConfigs
SmallRyeConfigSectionPage - Class in org.apache.polaris.docs.generator
StorageAccessPropertyConfigs - Class in org.apache.polaris.docs.generator: Processes the StorageAccessProperty enum to extract vended-credentials documentation, grouped by storage type.
StorageAccessPropertyConfigs(DocletEnvironment) - Constructor for class org.apache.polaris.docs.generator.StorageAccessPropertyConfigs
StorageAccessPropertyInfo - Record Class in org.apache.polaris.docs.generator: Holds information about a StorageAccessProperty enum constant.
StorageAccessPropertyInfo(String, String, String, boolean, String, String) - Constructor for record class org.apache.polaris.docs.generator.StorageAccessPropertyInfo: Creates an instance of a StorageAccessPropertyInfo record class.
StorageAccessPropertySectionPage - Class in org.apache.polaris.docs.generator: Generates a markdown table for a group of StorageAccessPropertyInfo entries.
StorageAccessPropertySectionPage(List<StorageAccessPropertyInfo>) - Constructor for class org.apache.polaris.docs.generator.StorageAccessPropertySectionPage
storageType() - Method in record class org.apache.polaris.docs.generator.StorageAccessPropertyInfo: Returns the value of the storageType record component.
suffixLabel() - Method in record class org.apache.polaris.docs.generator.StorageAccessPropertyInfo: Returns the value of the suffixLabel record component.

T

toString() - Method in record class org.apache.polaris.docs.generator.PolarisConfigurationInfo: Returns a string representation of this record class.
toString() - Method in record class org.apache.polaris.docs.generator.StorageAccessPropertyInfo: Returns a string representation of this record class.
type() - Method in record class org.apache.polaris.docs.generator.PolarisConfigurationInfo: Returns the value of the type record component.

U

unnamedKey() - Method in class org.apache.polaris.docs.generator.SmallRyeConfigPropertyInfo: Returns the unnamed key value if the property has WithUnnamedKey annotation.

V

valueType() - Method in record class org.apache.polaris.docs.generator.StorageAccessPropertyInfo: Returns the value of the valueType record component.
visitor() - Method in class org.apache.polaris.docs.generator.PropertiesConfigs

W

writeTo(PrintWriter) - Method in class org.apache.polaris.docs.generator.PolarisConfigurationSectionPage
writeTo(PrintWriter) - Method in class org.apache.polaris.docs.generator.SmallRyeConfigSectionPage
writeTo(PrintWriter) - Method in class org.apache.polaris.docs.generator.StorageAccessPropertySectionPage

A B C D E F G H I M N O P R S T U V W
All Classes and Interfaces|All Packages