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