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