View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.tools.plugin.extractor.annotations.converter.tag.block;
20  
21  import javax.inject.Named;
22  import javax.inject.Singleton;
23  
24  import org.apache.maven.tools.plugin.extractor.annotations.converter.ConverterContext;
25  import org.apache.maven.tools.plugin.extractor.annotations.converter.tag.LinkUtils;
26  
27  /**
28   * Supports <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#see">block see
29   * taglet</a>.
30   */
31  @Named("see")
32  @Singleton
33  public class SeeTagConverter extends JavadocBlockTagToHtmlConverter {
34      private static final String ATTRIBUTE_NAME_IS_FIRST_REFERENCE = "SeeTagletConverter.isFirstReference";
35  
36      @Override
37      public String convert(String value, ConverterContext context) {
38          StringBuilder htmlBuilder = new StringBuilder();
39          Boolean isFirstReference = context.getAttribute(ATTRIBUTE_NAME_IS_FIRST_REFERENCE, Boolean.class, Boolean.TRUE);
40          if (Boolean.TRUE.equals(isFirstReference)) {
41              // headline only once per instance
42              htmlBuilder.append("<br/><strong>See also:</strong>\n");
43              context.setAttribute(ATTRIBUTE_NAME_IS_FIRST_REFERENCE, Boolean.FALSE);
44          } else {
45              // multiple links just comma separated,
46              htmlBuilder.append(", ");
47          }
48          // is it regular HTML link?
49          if (value.startsWith("<a href")) {
50              return htmlBuilder.append(value).toString();
51          }
52          // is it just a soft string reference?
53          if (value.startsWith("\"")) {
54              return htmlBuilder.append(value).toString();
55          }
56          String link = LinkUtils.createLink(value, context);
57          htmlBuilder.append(link);
58          return htmlBuilder.toString();
59      }
60  }