    001// Licensed under the Apache License, Version 2.0 (the "License");
    002// you may not use this file except in compliance with the License.
    003// You may obtain a copy of the License at
    004//
    005//     http://www.apache.org/licenses/LICENSE-2.0
    006//
    007// Unless required by applicable law or agreed to in writing, software
    008// distributed under the License is distributed on an "AS IS" BASIS,
    009// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    010// See the License for the specific language governing permissions and
    011// limitations under the License.
    012
    013package org.apache.tapestry5.services;
    014
    015import org.apache.tapestry5.MarkupWriter;
    016import org.apache.tapestry5.ioc.annotations.UsesMappedConfiguration;
    017
    018/**
    019 * A strategy interface used for converting an object into markup that describes that object. This is primarily used in
    020 * terms of an {@link org.apache.tapestry5.services.ExceptionReporter} page.
    021 *
    022 * The ObjectRenderer service (distinguished by the @{@link org.apache.tapestry5.ioc.annotations.Primary} marker
    023 * annotation) uses {@linkplain org.apache.tapestry5.ioc.services.StrategyBuilder type-based matching} to find a
    024 * specific ObjectRenderer for any given type.
    025 */
    026@UsesMappedConfiguration(key = Class.class, value = ObjectRenderer.class)
    027public interface ObjectRenderer<T>
    028{
    029    /**
    030     * Renders the object out as markup.
    031     *
    032     * @param object to be rendered
    033     * @param writer to which output should be directed
    034     */
    035    void render(T object, MarkupWriter writer);
    036}