Annotations to support config/counters documentation/validation

aeron-annotations/src/main/java/io/aeron/config/Config.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2014-2024 Real Logic Limited.
+ *
+ * Licensed 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 io.aeron.config;
+
+import java.lang.annotation.*;
+
+/**
+ * Annotation to indicate this is a config option
+ */
+@Target({ElementType.FIELD, ElementType.METHOD})
+@Retention(RetentionPolicy.SOURCE)
+@SuppressWarnings("checkstyle:MissingJavadocMethod")
+public @interface Config
+{
+    @SuppressWarnings("checkstyle:MissingJavadocType")
+    enum Type
+    {
+        UNDEFINED, PROPERTY_NAME, DEFAULT
+    }
+
+    Type configType() default Type.UNDEFINED;
+
+    String id() default "";
+
+    String uriParam() default "";
+
+    boolean existsInC() default true;
+
+    String expectedCEnvVarFieldName() default "";
+
+    String expectedCEnvVar() default "";
+
+    String expectedCDefaultFieldName() default "";
+
+    String expectedCDefault() default "";
+
+    DefaultType defaultType() default DefaultType.UNDEFINED;
+
+    boolean defaultBoolean() default false;
+
+    int defaultInt() default 0;
+
+    long defaultLong() default 0;
+
+    String defaultString() default "";
+}

aeron-annotations/src/main/java/io/aeron/config/ConfigInfo.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright 2014-2024 Real Logic Limited.
+ *
+ * Licensed 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 io.aeron.config;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+@SuppressWarnings("checkstyle:MissingJavadocType")
+public class ConfigInfo
+{
+    @JsonProperty
+    public final String id;
+    @JsonProperty
+    public final ExpectedConfig expectations;
+
+    public ConfigInfo(@JsonProperty("id") final String id)
+    {
+        this.id = id;
+        expectations = new ExpectedConfig();
+    }
+
+    public boolean foundPropertyName = false;
+    public boolean foundDefault = false;
+    @JsonProperty
+    public String propertyNameDescription;
+    @JsonProperty
+    public String propertyNameFieldName;
+    @JsonProperty
+    public String propertyNameClassName;
+    @JsonProperty
+    public String propertyName;
+    @JsonProperty
+    public String defaultDescription;
+    @JsonProperty
+    public String defaultFieldName;
+    @JsonProperty
+    public String defaultClassName;
+    @JsonProperty
+    public Object defaultValue;
+    @JsonProperty
+    public DefaultType defaultValueType = DefaultType.UNDEFINED;
+    @JsonProperty
+    public Object overrideDefaultValue;
+    @JsonProperty
+    public DefaultType overrideDefaultValueType = DefaultType.UNDEFINED;
+    @JsonProperty
+    public String uriParam;
+    @JsonProperty
+    public String context;
+}