1 package org.apache.maven.tools.plugin.extractor.annotations.converter.tag;
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 java.util.regex.Pattern;
23
24 import org.apache.maven.tools.plugin.extractor.annotations.converter.ConverterContext;
25 import org.apache.maven.tools.plugin.extractor.annotations.converter.tag.block.JavadocBlockTagToHtmlConverter;
26 import org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline.JavadocInlineTagToHtmlConverter;
27
28 /**
29 * Common base class of both {@link JavadocBlockTagToHtmlConverter} and {@link JavadocInlineTagToHtmlConverter}.
30 */
31 public abstract class JavadocTagToHtmlConverter
32 {
33
34 private static final Pattern LT = Pattern.compile( "<" );
35 private static final Pattern GT = Pattern.compile( ">" );
36
37 /**
38 *
39 * @param text the value of the tag
40 * @param context the content of the tag (may be empty in case there was no content given)
41 * @return the converted text which represents the tag with the given value in html
42 */
43 public abstract String convert( String text, ConverterContext context );
44
45 /** Mostly a copy of {@code org.codehaus.plexus.util.xml.PrettyPrintXMLWriter#escapeXml(String)}. */
46 protected static String escapeXmlElement( String text )
47 {
48 if ( text.indexOf( '<' ) >= 0 )
49 {
50 text = LT.matcher( text ).replaceAll( "<" );
51 }
52
53 if ( text.indexOf( '>' ) >= 0 )
54 {
55 text = GT.matcher( text ).replaceAll( ">" );
56 }
57 return text;
58 }
59
60 }