1 /*
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.metaschema.core.datatype.markup;
28
29 import com.vladsch.flexmark.util.ast.Document;
30
31 import gov.nist.secauto.metaschema.core.datatype.markup.flexmark.FlexmarkFactory;
32
33 import edu.umd.cs.findbugs.annotations.NonNull;
34
35 public class MarkupMultiline
36 extends AbstractMarkupString<MarkupMultiline> {
37
38 @NonNull
39 private static final FlexmarkFactory FLEXMARK_FACTORY = FlexmarkFactory.instance();
40
41 /**
42 * Convert the provided HTML string into markup.
43 *
44 * @param html
45 * the HTML
46 * @return the multiline markup instance
47 */
48 @NonNull
49 public static MarkupMultiline fromHtml(@NonNull String html) {
50 return new MarkupMultiline(
51 parseHtml(
52 html,
53 FLEXMARK_FACTORY.getFlexmarkHtmlConverter(),
54 FLEXMARK_FACTORY.getMarkdownParser()));
55 }
56
57 /**
58 * Convert the provided markdown string into markup.
59 *
60 * @param markdown
61 * the markup
62 * @return the multiline markup instance
63 */
64 @NonNull
65 public static MarkupMultiline fromMarkdown(@NonNull String markdown) {
66 return new MarkupMultiline(
67 parseMarkdown(markdown, FLEXMARK_FACTORY.getMarkdownParser()));
68 }
69
70 /**
71 * Construct a new multiline markup instance.
72 *
73 * @param astNode
74 * the parsed markup AST
75 */
76 public MarkupMultiline(@NonNull Document astNode) {
77 super(astNode);
78 }
79
80 @Override
81 public FlexmarkFactory getFlexmarkFactory() {
82 return FLEXMARK_FACTORY;
83 }
84
85 @Override
86 public MarkupMultiline copy() {
87 // TODO: find a way to do a deep copy
88 // this is a shallow copy that uses the same underlying Document object
89 return new MarkupMultiline(getDocument());
90 }
91
92 @Override
93 public boolean isBlock() {
94 return true;
95 }
96 }