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.formatter.Formatter;
030import com.vladsch.flexmark.util.ast.Document;
031import com.vladsch.flexmark.util.ast.Node;
032
033import gov.nist.secauto.metaschema.core.datatype.ICustomJavaDataType;
034import gov.nist.secauto.metaschema.core.datatype.markup.flexmark.FlexmarkFactory;
035import gov.nist.secauto.metaschema.core.datatype.markup.flexmark.InsertAnchorExtension.InsertAnchorNode;
036
037import org.codehaus.stax2.XMLStreamWriter2;
038import org.codehaus.stax2.evt.XMLEventFactory2;
039
040import java.io.IOException;
041import java.util.List;
042import java.util.function.Predicate;
043import java.util.stream.Stream;
044
045import javax.xml.stream.XMLEventWriter;
046import javax.xml.stream.XMLStreamException;
047
048import edu.umd.cs.findbugs.annotations.NonNull;
049
050public interface IMarkupString<TYPE extends IMarkupString<TYPE>>
051    extends ICustomJavaDataType<TYPE> {
052  @NonNull
053  FlexmarkFactory getFlexmarkFactory();
054
055  @NonNull
056  Document getDocument();
057
058  // /**
059  // * Write HTML content to the provided {@code xmlStreamWriter} using the
060  // provided {@code
061  // namespace}.
062  // *
063  // * @param writer
064  // * the writer
065  // * @param namespace
066  // * the XML namespace for the HTML
067  // * @throws XMLStreamException
068  // * if an error occurred while writing
069  // */
070  // void writeHtml(@NonNull XMLStreamWriter2 writer, @NonNull String namespace)
071  // throws
072  // XMLStreamException;
073
074  @NonNull
075  String toHtml();
076
077  @NonNull
078  String toXHtml(@NonNull String namespace) throws XMLStreamException, IOException;
079
080  @NonNull
081  String toMarkdown();
082
083  @NonNull
084  String toMarkdown(@NonNull Formatter formatter);
085
086  /**
087   * Retrieve all nodes contained within this markup text as a stream.
088   *
089   * @return a depth first stream
090   */
091  @NonNull
092  Stream<Node> getNodesAsStream();
093
094  @NonNull
095  default List<InsertAnchorNode> getInserts() {
096    return getInserts(insert -> true);
097  }
098
099  /**
100   * Retrieve all insert statements that are contained within this markup text
101   * that match the provided filter.
102   *
103   * @param filter
104   *          a filter used to identify matching insert statements
105   * @return the matching insert statements
106   */
107  @NonNull
108  List<InsertAnchorNode> getInserts(
109      @NonNull Predicate<InsertAnchorNode> filter);
110
111  /**
112   * Determine if the Markup consists of block elements.
113   *
114   * @return {@code true} if the markup consists of block elements, or
115   *         {@code false} otherwise
116   */
117  boolean isBlock();
118
119  void writeXHtml(
120      @NonNull String namespace,
121      @NonNull XMLStreamWriter2 streamWriter) throws XMLStreamException;
122
123  void writeXHtml(
124      @NonNull String namespace,
125      @NonNull XMLEventFactory2 eventFactory,
126      @NonNull XMLEventWriter eventWriter) throws XMLStreamException;
127}