001/*
002 * Portions of this software was developed by employees of the National Institute
003 * of Standards and Technology (NIST), an agency of the Federal Government and is
004 * being made available as a public service. Pursuant to title 17 United States
005 * Code Section 105, works of NIST employees are not subject to copyright
006 * protection in the United States. This software may be subject to foreign
007 * copyright. Permission in the United States and in foreign countries, to the
008 * extent that NIST may hold copyright, to use, copy, modify, create derivative
009 * works, and distribute this software and its documentation without fee is hereby
010 * granted on a non-exclusive basis, provided that this notice and disclaimer
011 * of warranty appears in all copies.
012 *
013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
025 */
026
027package gov.nist.secauto.metaschema.core.datatype.markup;
028
029import com.vladsch.flexmark.util.ast.Document;
030
031import gov.nist.secauto.metaschema.core.datatype.markup.flexmark.FlexmarkFactory;
032
033import edu.umd.cs.findbugs.annotations.NonNull;
034
035public class MarkupMultiline
036    extends AbstractMarkupString<MarkupMultiline> {
037
038  @NonNull
039  private static final FlexmarkFactory FLEXMARK_FACTORY = FlexmarkFactory.instance();
040
041  /**
042   * Convert the provided HTML string into markup.
043   *
044   * @param html
045   *          the HTML
046   * @return the multiline markup instance
047   */
048  @NonNull
049  public static MarkupMultiline fromHtml(@NonNull String html) {
050    return new MarkupMultiline(
051        parseHtml(
052            html,
053            FLEXMARK_FACTORY.getFlexmarkHtmlConverter(),
054            FLEXMARK_FACTORY.getMarkdownParser()));
055  }
056
057  /**
058   * Convert the provided markdown string into markup.
059   *
060   * @param markdown
061   *          the markup
062   * @return the multiline markup instance
063   */
064  @NonNull
065  public static MarkupMultiline fromMarkdown(@NonNull String markdown) {
066    return new MarkupMultiline(
067        parseMarkdown(markdown, FLEXMARK_FACTORY.getMarkdownParser()));
068  }
069
070  /**
071   * Construct a new multiline markup instance.
072   *
073   * @param astNode
074   *          the parsed markup AST
075   */
076  public MarkupMultiline(@NonNull Document astNode) {
077    super(astNode);
078  }
079
080  @Override
081  public FlexmarkFactory getFlexmarkFactory() {
082    return FLEXMARK_FACTORY;
083  }
084
085  @Override
086  public MarkupMultiline copy() {
087    // TODO: find a way to do a deep copy
088    // this is a shallow copy that uses the same underlying Document object
089    return new MarkupMultiline(getDocument());
090  }
091
092  @Override
093  public boolean isBlock() {
094    return true;
095  }
096}