org.springframework.restdocs.templates.TemplateFormat.java Source code

Introduction

Here is the source code for org.springframework.restdocs.templates.TemplateFormat.java

Source

/*
 * Copyright 2014-2016 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.restdocs.templates;

/**
 * A {@link TemplateFormat} provides information about a particular template format, such
 * as Asciidoctor or Markdown.
 *
 * @author Andy Wilkinson
 * @since 1.1.0
 */
public interface TemplateFormat {

    /**
     * Returns the id of this template format.
     * @return the id
     */
    String getId();

    /**
     * Returns the file extension to use for files generated from templates in this
     * format.
     * @return the file extension
     */
    String getFileExtension();

}