org.coodex.concrete.apitools.ConcreteAPIRenderer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of concrete-api-tools Show documentation

There is a newer version: 0.5.3-RC1

/*
 * Copyright (c) 2018 coodex.org ([email protected])
 *
 * 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
 *
 * http://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.coodex.concrete.apitools;

import org.coodex.concrete.common.modules.AbstractModule;

import java.io.IOException;
import java.util.List;
import java.util.Map;

/**
 * Created by davidoff shen on 2016-11-30.
 */
public interface ConcreteAPIRenderer> {

    /**
     * 例如：
     *   服务提供类型：JaxRS
     *   类型：code, doc
     *   使用者：backend, jquery, angularjs, angualr2, java, c#等
     *   文档化格式：gitbook, asciidoctor, markdown
     *
     * @param desc 服务提供类型.类型.使用者.文档化格式.版本
     * @return 是否受理desc
     */
    boolean isAccept(String desc);

//    /**
//     * @param packages 检索的包
//     */
////    @Deprecated // todo 使用 classes 替代
//    @Deprecated
//    void writeTo(String... packages) throws IOException;

    void render(List modules) throws IOException;

    void setRoot(String rootPath);

    void setExt(Map ext);

}