1 /*
2 * Copyright (c) 2002-2025, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34
35 package fr.paris.lutece.portal.service.editor;
36
37 /**
38 * Interface for Markdown to HTML parser. Provides methods to get and set the prefix and name, and to parse content from Markdown to HTML.
39 */
40 public interface IRichTextContentParser
41 {
42
43 /**
44 * Gets the prefix.
45 *
46 * @return the prefix
47 */
48 public String getPrefix( );
49
50 /**
51 * Sets the prefix.
52 *
53 * @param strPrefix
54 * the prefix to set
55 */
56 public void setPrefix( String strPrefix );
57
58 /**
59 * Gets the name.
60 *
61 * @return the name
62 */
63 public String getName( );
64
65 /**
66 * Sets the name.
67 *
68 * @param strName
69 * the name to set
70 */
71 public void setName( String strName );
72
73 /**
74 * Converts Markdown content to HTML.
75 *
76 * @param content
77 * the Markdown content to be converted
78 * @return the converted HTML content
79 * @throws RichTextParsingException
80 */
81 public String parseContent( String content ) throws RichTextParsingException;
82 }