| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Markdown |
|
| 1.0;1 |
| 1 | /** | |
| 2 | * Copyright (c) 2013-2017, jcabi.com | |
| 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: 1) Redistributions of source code must retain the above | |
| 8 | * copyright notice, this list of conditions and the following | |
| 9 | * disclaimer. 2) Redistributions in binary form must reproduce the above | |
| 10 | * copyright notice, this list of conditions and the following | |
| 11 | * disclaimer in the documentation and/or other materials provided | |
| 12 | * with the distribution. 3) Neither the name of the jcabi.com nor | |
| 13 | * the names of its contributors may be used to endorse or promote | |
| 14 | * products derived from this software without specific prior written | |
| 15 | * permission. | |
| 16 | * | |
| 17 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| 18 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT | |
| 19 | * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND | |
| 20 | * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL | |
| 21 | * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, | |
| 22 | * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | |
| 23 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
| 24 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
| 25 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
| 26 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
| 27 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | |
| 28 | * OF THE POSSIBILITY OF SUCH DAMAGE. | |
| 29 | */ | |
| 30 | package com.jcabi.github; | |
| 31 | ||
| 32 | import com.jcabi.aspects.Immutable; | |
| 33 | import java.io.IOException; | |
| 34 | import javax.json.JsonObject; | |
| 35 | ||
| 36 | /** | |
| 37 | * Markdown API. | |
| 38 | * | |
| 39 | * @author Yegor Bugayenko (yegor@tpc2.com) | |
| 40 | * @version $Id: e06ee5f5eb8968f50aa762cd851b08ba562b244e $ | |
| 41 | * @since 0.6 | |
| 42 | * @see <a href="http://developer.github.com/v3/markdown/">Markdown API</a> | |
| 43 | */ | |
| 44 | @Immutable | |
| 45 | public interface Markdown { | |
| 46 | ||
| 47 | /** | |
| 48 | * Get its owner. | |
| 49 | * @return Github | |
| 50 | */ | |
| 51 | Github github(); | |
| 52 | ||
| 53 | /** | |
| 54 | * Render. | |
| 55 | * @param json JSON parameters | |
| 56 | * @return HTML | |
| 57 | * @throws IOException If it fails due to I/O problem | |
| 58 | */ | |
| 59 | String render(JsonObject json) | |
| 60 | throws IOException; | |
| 61 | ||
| 62 | /** | |
| 63 | * Raw rendering. | |
| 64 | * @param text Text in Markdown format | |
| 65 | * @return HTML | |
| 66 | * @throws IOException If it fails due to I/O problem | |
| 67 | */ | |
| 68 | String raw(String text) | |
| 69 | throws IOException; | |
| 70 | ||
| 71 | } |