Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions hadoop-common-project/hadoop-annotations/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,45 @@
</plugins>
</build>
</profile>
<profile>
<id>jdk17</id>
<activation>
<jdk>[17,)</jdk>
</activation>
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<executions>
<execution>
<id>add-java17-sources</id>
<phase>generate-sources</phase>
<goals>
<goal>add-source</goal>
</goals>
<configuration>
<sources>
<source>${basedir}/src/main/java17</source>
</sources>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<release>17</release>
<compilerArgs>
<arg>--add-modules</arg>
<arg>jdk.javadoc</arg>
</compilerArgs>
</configuration>
</plugin>
</plugins>
</build>
</profile>
</profiles>

</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
/*
* 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.hadoop.classification.tools;

import jdk.javadoc.doclet.DocletEnvironment;
import jdk.javadoc.doclet.Reporter;
import javax.lang.model.SourceVersion;

import jdiff.JDiff;

/**
* <a href="https://docs.oracle.com/en/java/javase/17/docs/api/jdk.javadoc/jdk/javadoc/doclet/Doclet.html">Doclet</a>
* for excluding elements that are annotated with
* {@link org.apache.hadoop.classification.InterfaceAudience.Private} or
* {@link org.apache.hadoop.classification.InterfaceAudience.LimitedPrivate}.
* It delegates to the JDiff Doclet, and takes the same options.
*/
public class ExcludePrivateAnnotationsJDiffDoclet {

Check failure on line 34 in hadoop-common-project/hadoop-annotations/src/main/java17/org/apache/hadoop/classification/tools/ExcludePrivateAnnotationsJDiffDoclet.java

View check run for this annotation

ASF Cloudbees Jenkins ci-hadoop / Apache Yetus

hadoop-common-project/hadoop-annotations/src/main/java17/org/apache/hadoop/classification/tools/ExcludePrivateAnnotationsJDiffDoclet.java#L34

blanks: end of line
public static SourceVersion languageVersion() {
return SourceVersion.RELEASE_17;
}

Check failure on line 38 in hadoop-common-project/hadoop-annotations/src/main/java17/org/apache/hadoop/classification/tools/ExcludePrivateAnnotationsJDiffDoclet.java

View check run for this annotation

ASF Cloudbees Jenkins ci-hadoop / Apache Yetus

hadoop-common-project/hadoop-annotations/src/main/java17/org/apache/hadoop/classification/tools/ExcludePrivateAnnotationsJDiffDoclet.java#L38

blanks: end of line
public static boolean start(DocletEnvironment root) {
System.out.println(
ExcludePrivateAnnotationsJDiffDoclet.class.getSimpleName());
return JDiff.start(RootDocProcessor.process(root));
}

Check failure on line 44 in hadoop-common-project/hadoop-annotations/src/main/java17/org/apache/hadoop/classification/tools/ExcludePrivateAnnotationsJDiffDoclet.java

View check run for this annotation

ASF Cloudbees Jenkins ci-hadoop / Apache Yetus

hadoop-common-project/hadoop-annotations/src/main/java17/org/apache/hadoop/classification/tools/ExcludePrivateAnnotationsJDiffDoclet.java#L44

blanks: end of line
public static int optionLength(String option) {
Integer length = StabilityOptions.optionLength(option);
if (length != null) {
return length;
}
return JDiff.optionLength(option);
}

Check failure on line 52 in hadoop-common-project/hadoop-annotations/src/main/java17/org/apache/hadoop/classification/tools/ExcludePrivateAnnotationsJDiffDoclet.java

View check run for this annotation

ASF Cloudbees Jenkins ci-hadoop / Apache Yetus

hadoop-common-project/hadoop-annotations/src/main/java17/org/apache/hadoop/classification/tools/ExcludePrivateAnnotationsJDiffDoclet.java#L52

blanks: end of line
public static boolean validOptions(String[][] options,
Reporter reporter) {
StabilityOptions.validOptions(options, reporter);
String[][] filteredOptions = StabilityOptions.filterOptions(options);
return JDiff.validOptions(filteredOptions, reporter);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
/*
* 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.hadoop.classification.tools;

import jdk.javadoc.doclet.Doclet;
import jdk.javadoc.doclet.DocletEnvironment;
import jdk.javadoc.doclet.Reporter;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;

import jdk.javadoc.doclet.StandardDoclet;

import java.util.Locale;
import java.util.Set;

/**
* <a href="https://docs.oracle.com/en/java/javase/17/docs/api/jdk.javadoc/jdk/javadoc/doclet/Doclet.html">Doclet</a>
* for excluding elements that are annotated with
* {@link org.apache.hadoop.classification.InterfaceAudience.Private} or
* {@link org.apache.hadoop.classification.InterfaceAudience.LimitedPrivate}.
* It delegates to the Standard Doclet, and takes the same options.
*/
public class ExcludePrivateAnnotationsStandardDoclet implements Doclet {

private final StandardDoclet delegate = new StandardDoclet();
private Reporter reporter;
private Locale locale;

public static SourceVersion languageVersion() {
return SourceVersion.RELEASE_17;
}

public static boolean start(DocletEnvironment root) {
System.out.println(ExcludePrivateAnnotationsStandardDoclet.class.getSimpleName());
if (root.getSpecifiedElements().isEmpty()) {
return true;
}
return new StandardDoclet().run(root);
}

public static int optionLength(String option) {
Integer length = StabilityOptions.optionLength(option);
if (length != null) {
return length;
}
for (Doclet.Option o : new StandardDoclet().getSupportedOptions()) {
for (String name : o.getNames()) {
if (name.equals(option)) {
return o.getArgumentCount() + 1;
}
}
}
return 0;
}

public static boolean validOptions(String[][] options, Reporter reporter) {
StabilityOptions.validOptions(options, reporter);
return true;
}

@Override
public void init(Locale locale, Reporter reporter) {
this.locale = locale;
this.reporter = reporter;
delegate.init(locale, reporter);
}

@Override
public String getName() {
return getClass().getSimpleName();
}

@Override
public Set<Option> getSupportedOptions() {
Set<Option> s = new java.util.HashSet<>(delegate.getSupportedOptions());
s.add(new Option() {
@Override
public int getArgumentCount() {
return 0;
}

@Override
public String getDescription() {
return "";
}

@Override
public Kind getKind() {
return Kind.OTHER;
}

@Override
public java.util.List<String> getNames() {
return java.util.Collections.singletonList("-unstable");
}

@Override
public String getParameters() {
return "";
}

@Override
public boolean process(String opt, java.util.List<String> args) {
StabilityOptions.setLevel(StabilityOptions.Level.UNSTABLE);
return true;
}
});
s.add(new Option() {
@Override
public int getArgumentCount() {
return 0;
}

@Override
public String getDescription() {
return "";
}

@Override
public Kind getKind() {
return Kind.OTHER;
}

@Override
public java.util.List<String> getNames() {
return java.util.Collections.singletonList("-evolving");
}

@Override
public String getParameters() {
return "";
}

@Override
public boolean process(String opt, java.util.List<String> args) {
StabilityOptions.setLevel(StabilityOptions.Level.EVOLVING);
return true;
}
});
return s;
}

@Override
public SourceVersion getSupportedSourceVersion() {
return SourceVersion.RELEASE_17;
}

@Override
public boolean run(DocletEnvironment environment) {
StabilityOptions.applyToRootProcessor();
DocletEnvironment ignored = RootDocProcessor.process(environment);

if (environment.getIncludedElements().isEmpty()) {
return true;
}
return delegate.run(environment);
}
}
Loading