001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.maven.tools.plugin.extractor.annotations.converter.tag;
020
021import java.util.regex.Pattern;
022
023import org.apache.maven.tools.plugin.extractor.annotations.converter.ConverterContext;
024import org.apache.maven.tools.plugin.extractor.annotations.converter.tag.block.JavadocBlockTagToHtmlConverter;
025import org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline.JavadocInlineTagToHtmlConverter;
026
027/**
028 * Common base class of both {@link JavadocBlockTagToHtmlConverter} and {@link JavadocInlineTagToHtmlConverter}.
029 */
030public abstract class JavadocTagToHtmlConverter {
031
032    private static final Pattern LT = Pattern.compile("<");
033    private static final Pattern GT = Pattern.compile(">");
034
035    /**
036     *
037     * @param text the value of the tag
038     * @param context the content of the tag (may be empty in case there was no content given)
039     * @return the converted text which represents the tag with the given value in html
040     */
041    public abstract String convert(String text, ConverterContext context);
042
043    /** Mostly a copy of {@code org.codehaus.plexus.util.xml.PrettyPrintXMLWriter#escapeXml(String)}. */
044    protected static String escapeXmlElement(String text) {
045        if (text.indexOf('<') >= 0) {
046            text = LT.matcher(text).replaceAll("&lt;");
047        }
048
049        if (text.indexOf('>') >= 0) {
050            text = GT.matcher(text).replaceAll("&gt;");
051        }
052        return text;
053    }
054}