fr.cenotelie.commons.lsp.structures.MarkedString Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2017 Association Cénotélie (cenotelie.fr)
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
 * Public License along with this program.
 * If not, see .
 ******************************************************************************/

package fr.cenotelie.commons.lsp.structures;

import fr.cenotelie.commons.utils.Serializable;

/**
 * MarkedString can be used to render human readable text.
 * It is either a markdown string or a code-block that provides a language and a code snippet.
 *
 * @author Laurent Wouters
 */
public interface MarkedString extends Serializable {
    /**
     * Gets whether this is a Markdown string
     *
     * @return Whether this is a Markdown string
     */
    boolean isMarkdown();
}