Renderer.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.schemarepo.server;

import java.util.Properties;

import org.schemarepo.SchemaEntry;
import org.schemarepo.Subject;

/**
 * Responsible for rendering various repository items (such as subjects and individual schemas)
 * based on a particular presentation technology (such as plain text, JSON, HTML, etc).
 */
public interface Renderer {

  /**
   * @return MediaType to send to the client
   */
  String getMediaType();

  String renderSubjects(Iterable<Subject> subjects);

  String renderSchemas(Iterable<SchemaEntry> schemaEntries);

  String renderSchemaEntry(SchemaEntry schemaEntry, boolean requestForLatest);

  String renderProperties(Properties props, String comment);

}