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